2 * File: sound/soc/codecs/ssm2602.c
5 * Created: Tue June 06 2008
6 * Description: Driver for ssm2602 sound chip
9 * Copyright 2008 Analog Devices Inc.
11 * Bugs: Enter bugs at http://blackfin.uclinux.org/
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, see the file COPYING, or write
25 * to the Free Software Foundation, Inc.,
26 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
29 #include <linux/module.h>
30 #include <linux/regmap.h>
31 #include <linux/slab.h>
33 #include <sound/pcm.h>
34 #include <sound/pcm_params.h>
35 #include <sound/soc.h>
36 #include <sound/tlv.h>
40 /* codec private data */
43 const struct snd_pcm_hw_constraint_list *sysclk_constraints;
45 struct regmap *regmap;
47 enum ssm2602_type type;
48 unsigned int clk_out_pwr;
52 * ssm2602 register cache
53 * We can't read the ssm2602 register space when we are
54 * using 2 wire for device control, so we cache them instead.
55 * There is no point in caching the reset register
57 static const u16 ssm2602_reg[SSM2602_CACHEREGNUM] = {
58 0x0097, 0x0097, 0x0079, 0x0079,
59 0x000a, 0x0008, 0x009f, 0x000a,
64 /*Appending several "None"s just for OSS mixer use*/
65 static const char *ssm2602_input_select[] = {
69 static const char *ssm2602_deemph[] = {"None", "32Khz", "44.1Khz", "48Khz"};
71 static const struct soc_enum ssm2602_enum[] = {
72 SOC_ENUM_SINGLE(SSM2602_APANA, 2, ARRAY_SIZE(ssm2602_input_select),
73 ssm2602_input_select),
74 SOC_ENUM_SINGLE(SSM2602_APDIGI, 1, ARRAY_SIZE(ssm2602_deemph),
78 static const unsigned int ssm260x_outmix_tlv[] = {
80 0, 47, TLV_DB_SCALE_ITEM(TLV_DB_GAIN_MUTE, 0, 0),
81 48, 127, TLV_DB_SCALE_ITEM(-7400, 100, 0),
84 static const DECLARE_TLV_DB_SCALE(ssm260x_inpga_tlv, -3450, 150, 0);
85 static const DECLARE_TLV_DB_SCALE(ssm260x_sidetone_tlv, -1500, 300, 0);
87 static const struct snd_kcontrol_new ssm260x_snd_controls[] = {
88 SOC_DOUBLE_R_TLV("Capture Volume", SSM2602_LINVOL, SSM2602_RINVOL, 0, 45, 0,
90 SOC_DOUBLE_R("Capture Switch", SSM2602_LINVOL, SSM2602_RINVOL, 7, 1, 1),
92 SOC_SINGLE("ADC High Pass Filter Switch", SSM2602_APDIGI, 0, 1, 1),
93 SOC_SINGLE("Store DC Offset Switch", SSM2602_APDIGI, 4, 1, 0),
95 SOC_ENUM("Playback De-emphasis", ssm2602_enum[1]),
98 static const struct snd_kcontrol_new ssm2602_snd_controls[] = {
99 SOC_DOUBLE_R_TLV("Master Playback Volume", SSM2602_LOUT1V, SSM2602_ROUT1V,
100 0, 127, 0, ssm260x_outmix_tlv),
101 SOC_DOUBLE_R("Master Playback ZC Switch", SSM2602_LOUT1V, SSM2602_ROUT1V,
103 SOC_SINGLE_TLV("Sidetone Playback Volume", SSM2602_APANA, 6, 3, 1,
104 ssm260x_sidetone_tlv),
106 SOC_SINGLE("Mic Boost (+20dB)", SSM2602_APANA, 0, 1, 0),
107 SOC_SINGLE("Mic Boost2 (+20dB)", SSM2602_APANA, 8, 1, 0),
108 SOC_SINGLE("Mic Switch", SSM2602_APANA, 1, 1, 1),
112 static const struct snd_kcontrol_new ssm260x_output_mixer_controls[] = {
113 SOC_DAPM_SINGLE("Line Bypass Switch", SSM2602_APANA, 3, 1, 0),
114 SOC_DAPM_SINGLE("HiFi Playback Switch", SSM2602_APANA, 4, 1, 0),
115 SOC_DAPM_SINGLE("Mic Sidetone Switch", SSM2602_APANA, 5, 1, 0),
119 static const struct snd_kcontrol_new ssm2602_input_mux_controls =
120 SOC_DAPM_ENUM("Input Select", ssm2602_enum[0]);
122 static const struct snd_soc_dapm_widget ssm260x_dapm_widgets[] = {
123 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", SSM2602_PWR, 3, 1),
124 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", SSM2602_PWR, 2, 1),
125 SND_SOC_DAPM_PGA("Line Input", SSM2602_PWR, 0, 1, NULL, 0),
127 SND_SOC_DAPM_SUPPLY("Digital Core Power", SSM2602_ACTIVE, 0, 0, NULL, 0),
129 SND_SOC_DAPM_OUTPUT("LOUT"),
130 SND_SOC_DAPM_OUTPUT("ROUT"),
131 SND_SOC_DAPM_INPUT("RLINEIN"),
132 SND_SOC_DAPM_INPUT("LLINEIN"),
135 static const struct snd_soc_dapm_widget ssm2602_dapm_widgets[] = {
136 SND_SOC_DAPM_MIXER("Output Mixer", SSM2602_PWR, 4, 1,
137 ssm260x_output_mixer_controls,
138 ARRAY_SIZE(ssm260x_output_mixer_controls)),
140 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0, &ssm2602_input_mux_controls),
141 SND_SOC_DAPM_MICBIAS("Mic Bias", SSM2602_PWR, 1, 1),
143 SND_SOC_DAPM_OUTPUT("LHPOUT"),
144 SND_SOC_DAPM_OUTPUT("RHPOUT"),
145 SND_SOC_DAPM_INPUT("MICIN"),
148 static const struct snd_soc_dapm_widget ssm2604_dapm_widgets[] = {
149 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM, 0, 0,
150 ssm260x_output_mixer_controls,
151 ARRAY_SIZE(ssm260x_output_mixer_controls) - 1), /* Last element is the mic */
154 static const struct snd_soc_dapm_route ssm260x_routes[] = {
155 {"DAC", NULL, "Digital Core Power"},
156 {"ADC", NULL, "Digital Core Power"},
158 {"Output Mixer", "Line Bypass Switch", "Line Input"},
159 {"Output Mixer", "HiFi Playback Switch", "DAC"},
161 {"ROUT", NULL, "Output Mixer"},
162 {"LOUT", NULL, "Output Mixer"},
164 {"Line Input", NULL, "LLINEIN"},
165 {"Line Input", NULL, "RLINEIN"},
168 static const struct snd_soc_dapm_route ssm2602_routes[] = {
169 {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
171 {"RHPOUT", NULL, "Output Mixer"},
172 {"LHPOUT", NULL, "Output Mixer"},
174 {"Input Mux", "Line", "Line Input"},
175 {"Input Mux", "Mic", "Mic Bias"},
176 {"ADC", NULL, "Input Mux"},
178 {"Mic Bias", NULL, "MICIN"},
181 static const struct snd_soc_dapm_route ssm2604_routes[] = {
182 {"ADC", NULL, "Line Input"},
185 static const unsigned int ssm2602_rates_12288000[] = {
186 8000, 16000, 32000, 48000, 96000,
189 static const struct snd_pcm_hw_constraint_list ssm2602_constraints_12288000 = {
190 .list = ssm2602_rates_12288000,
191 .count = ARRAY_SIZE(ssm2602_rates_12288000),
194 static const unsigned int ssm2602_rates_11289600[] = {
195 8000, 11025, 22050, 44100, 88200,
198 static const struct snd_pcm_hw_constraint_list ssm2602_constraints_11289600 = {
199 .list = ssm2602_rates_11289600,
200 .count = ARRAY_SIZE(ssm2602_rates_11289600),
203 struct ssm2602_coeff {
209 #define SSM2602_COEFF_SRATE(sr, bosr, usb) (((sr) << 2) | ((bosr) << 1) | (usb))
211 /* codec mclk clock coefficients */
212 static const struct ssm2602_coeff ssm2602_coeff_table[] = {
214 {12288000, 48000, SSM2602_COEFF_SRATE(0x0, 0x0, 0x0)},
215 {18432000, 48000, SSM2602_COEFF_SRATE(0x0, 0x1, 0x0)},
216 {12000000, 48000, SSM2602_COEFF_SRATE(0x0, 0x0, 0x1)},
219 {12288000, 32000, SSM2602_COEFF_SRATE(0x6, 0x0, 0x0)},
220 {18432000, 32000, SSM2602_COEFF_SRATE(0x6, 0x1, 0x0)},
221 {12000000, 32000, SSM2602_COEFF_SRATE(0x6, 0x0, 0x1)},
224 {12288000, 16000, SSM2602_COEFF_SRATE(0x5, 0x0, 0x0)},
225 {18432000, 16000, SSM2602_COEFF_SRATE(0x5, 0x1, 0x0)},
226 {12000000, 16000, SSM2602_COEFF_SRATE(0xa, 0x0, 0x1)},
229 {12288000, 8000, SSM2602_COEFF_SRATE(0x3, 0x0, 0x0)},
230 {18432000, 8000, SSM2602_COEFF_SRATE(0x3, 0x1, 0x0)},
231 {11289600, 8000, SSM2602_COEFF_SRATE(0xb, 0x0, 0x0)},
232 {16934400, 8000, SSM2602_COEFF_SRATE(0xb, 0x1, 0x0)},
233 {12000000, 8000, SSM2602_COEFF_SRATE(0x3, 0x0, 0x1)},
236 {12288000, 96000, SSM2602_COEFF_SRATE(0x7, 0x0, 0x0)},
237 {18432000, 96000, SSM2602_COEFF_SRATE(0x7, 0x1, 0x0)},
238 {12000000, 96000, SSM2602_COEFF_SRATE(0x7, 0x0, 0x1)},
241 {11289600, 11025, SSM2602_COEFF_SRATE(0xc, 0x0, 0x0)},
242 {16934400, 11025, SSM2602_COEFF_SRATE(0xc, 0x1, 0x0)},
243 {12000000, 11025, SSM2602_COEFF_SRATE(0xc, 0x1, 0x1)},
246 {11289600, 22050, SSM2602_COEFF_SRATE(0xd, 0x0, 0x0)},
247 {16934400, 22050, SSM2602_COEFF_SRATE(0xd, 0x1, 0x0)},
248 {12000000, 22050, SSM2602_COEFF_SRATE(0xd, 0x1, 0x1)},
251 {11289600, 44100, SSM2602_COEFF_SRATE(0x8, 0x0, 0x0)},
252 {16934400, 44100, SSM2602_COEFF_SRATE(0x8, 0x1, 0x0)},
253 {12000000, 44100, SSM2602_COEFF_SRATE(0x8, 0x1, 0x1)},
256 {11289600, 88200, SSM2602_COEFF_SRATE(0xf, 0x0, 0x0)},
257 {16934400, 88200, SSM2602_COEFF_SRATE(0xf, 0x1, 0x0)},
258 {12000000, 88200, SSM2602_COEFF_SRATE(0xf, 0x1, 0x1)},
261 static inline int ssm2602_get_coeff(int mclk, int rate)
265 for (i = 0; i < ARRAY_SIZE(ssm2602_coeff_table); i++) {
266 if (ssm2602_coeff_table[i].rate == rate &&
267 ssm2602_coeff_table[i].mclk == mclk)
268 return ssm2602_coeff_table[i].srate;
273 static int ssm2602_hw_params(struct snd_pcm_substream *substream,
274 struct snd_pcm_hw_params *params,
275 struct snd_soc_dai *dai)
277 struct snd_soc_codec *codec = dai->codec;
278 struct ssm2602_priv *ssm2602 = snd_soc_codec_get_drvdata(codec);
279 int srate = ssm2602_get_coeff(ssm2602->sysclk, params_rate(params));
285 regmap_write(ssm2602->regmap, SSM2602_SRATE, srate);
288 switch (params_width(params)) {
304 regmap_update_bits(ssm2602->regmap, SSM2602_IFACE,
305 IFACE_AUDIO_DATA_LEN, iface);
309 static int ssm2602_startup(struct snd_pcm_substream *substream,
310 struct snd_soc_dai *dai)
312 struct snd_soc_codec *codec = dai->codec;
313 struct ssm2602_priv *ssm2602 = snd_soc_codec_get_drvdata(codec);
315 if (ssm2602->sysclk_constraints) {
316 snd_pcm_hw_constraint_list(substream->runtime, 0,
317 SNDRV_PCM_HW_PARAM_RATE,
318 ssm2602->sysclk_constraints);
324 static int ssm2602_mute(struct snd_soc_dai *dai, int mute)
326 struct ssm2602_priv *ssm2602 = snd_soc_codec_get_drvdata(dai->codec);
329 regmap_update_bits(ssm2602->regmap, SSM2602_APDIGI,
330 APDIGI_ENABLE_DAC_MUTE,
331 APDIGI_ENABLE_DAC_MUTE);
333 regmap_update_bits(ssm2602->regmap, SSM2602_APDIGI,
334 APDIGI_ENABLE_DAC_MUTE, 0);
338 static int ssm2602_set_dai_sysclk(struct snd_soc_dai *codec_dai,
339 int clk_id, unsigned int freq, int dir)
341 struct snd_soc_codec *codec = codec_dai->codec;
342 struct ssm2602_priv *ssm2602 = snd_soc_codec_get_drvdata(codec);
344 if (dir == SND_SOC_CLOCK_IN) {
345 if (clk_id != SSM2602_SYSCLK)
351 ssm2602->sysclk_constraints = &ssm2602_constraints_12288000;
355 ssm2602->sysclk_constraints = &ssm2602_constraints_11289600;
358 ssm2602->sysclk_constraints = NULL;
363 ssm2602->sysclk = freq;
368 case SSM2602_CLK_CLKOUT:
369 mask = PWR_CLK_OUT_PDN;
371 case SSM2602_CLK_XTO:
379 ssm2602->clk_out_pwr |= mask;
381 ssm2602->clk_out_pwr &= ~mask;
383 regmap_update_bits(ssm2602->regmap, SSM2602_PWR,
384 PWR_CLK_OUT_PDN | PWR_OSC_PDN, ssm2602->clk_out_pwr);
390 static int ssm2602_set_dai_fmt(struct snd_soc_dai *codec_dai,
393 struct ssm2602_priv *ssm2602 = snd_soc_codec_get_drvdata(codec_dai->codec);
394 unsigned int iface = 0;
396 /* set master/slave audio interface */
397 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
398 case SND_SOC_DAIFMT_CBM_CFM:
401 case SND_SOC_DAIFMT_CBS_CFS:
407 /* interface format */
408 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
409 case SND_SOC_DAIFMT_I2S:
412 case SND_SOC_DAIFMT_RIGHT_J:
414 case SND_SOC_DAIFMT_LEFT_J:
417 case SND_SOC_DAIFMT_DSP_A:
420 case SND_SOC_DAIFMT_DSP_B:
427 /* clock inversion */
428 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
429 case SND_SOC_DAIFMT_NB_NF:
431 case SND_SOC_DAIFMT_IB_IF:
434 case SND_SOC_DAIFMT_IB_NF:
437 case SND_SOC_DAIFMT_NB_IF:
445 regmap_write(ssm2602->regmap, SSM2602_IFACE, iface);
449 static int ssm2602_set_bias_level(struct snd_soc_codec *codec,
450 enum snd_soc_bias_level level)
452 struct ssm2602_priv *ssm2602 = snd_soc_codec_get_drvdata(codec);
455 case SND_SOC_BIAS_ON:
456 /* vref/mid on, osc and clkout on if enabled */
457 regmap_update_bits(ssm2602->regmap, SSM2602_PWR,
458 PWR_POWER_OFF | PWR_CLK_OUT_PDN | PWR_OSC_PDN,
459 ssm2602->clk_out_pwr);
461 case SND_SOC_BIAS_PREPARE:
463 case SND_SOC_BIAS_STANDBY:
464 /* everything off except vref/vmid, */
465 regmap_update_bits(ssm2602->regmap, SSM2602_PWR,
466 PWR_POWER_OFF | PWR_CLK_OUT_PDN | PWR_OSC_PDN,
467 PWR_CLK_OUT_PDN | PWR_OSC_PDN);
469 case SND_SOC_BIAS_OFF:
471 regmap_update_bits(ssm2602->regmap, SSM2602_PWR,
472 PWR_POWER_OFF, PWR_POWER_OFF);
476 codec->dapm.bias_level = level;
480 #define SSM2602_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 |\
481 SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 |\
482 SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
483 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
484 SNDRV_PCM_RATE_96000)
486 #define SSM2602_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
487 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
489 static const struct snd_soc_dai_ops ssm2602_dai_ops = {
490 .startup = ssm2602_startup,
491 .hw_params = ssm2602_hw_params,
492 .digital_mute = ssm2602_mute,
493 .set_sysclk = ssm2602_set_dai_sysclk,
494 .set_fmt = ssm2602_set_dai_fmt,
497 static struct snd_soc_dai_driver ssm2602_dai = {
498 .name = "ssm2602-hifi",
500 .stream_name = "Playback",
503 .rates = SSM2602_RATES,
504 .formats = SSM2602_FORMATS,},
506 .stream_name = "Capture",
509 .rates = SSM2602_RATES,
510 .formats = SSM2602_FORMATS,},
511 .ops = &ssm2602_dai_ops,
512 .symmetric_rates = 1,
513 .symmetric_samplebits = 1,
516 static int ssm2602_resume(struct snd_soc_codec *codec)
518 struct ssm2602_priv *ssm2602 = snd_soc_codec_get_drvdata(codec);
520 regcache_sync(ssm2602->regmap);
525 static int ssm2602_codec_probe(struct snd_soc_codec *codec)
527 struct ssm2602_priv *ssm2602 = snd_soc_codec_get_drvdata(codec);
528 struct snd_soc_dapm_context *dapm = &codec->dapm;
531 regmap_update_bits(ssm2602->regmap, SSM2602_LOUT1V,
532 LOUT1V_LRHP_BOTH, LOUT1V_LRHP_BOTH);
533 regmap_update_bits(ssm2602->regmap, SSM2602_ROUT1V,
534 ROUT1V_RLHP_BOTH, ROUT1V_RLHP_BOTH);
536 ret = snd_soc_add_codec_controls(codec, ssm2602_snd_controls,
537 ARRAY_SIZE(ssm2602_snd_controls));
541 ret = snd_soc_dapm_new_controls(dapm, ssm2602_dapm_widgets,
542 ARRAY_SIZE(ssm2602_dapm_widgets));
546 return snd_soc_dapm_add_routes(dapm, ssm2602_routes,
547 ARRAY_SIZE(ssm2602_routes));
550 static int ssm2604_codec_probe(struct snd_soc_codec *codec)
552 struct snd_soc_dapm_context *dapm = &codec->dapm;
555 ret = snd_soc_dapm_new_controls(dapm, ssm2604_dapm_widgets,
556 ARRAY_SIZE(ssm2604_dapm_widgets));
560 return snd_soc_dapm_add_routes(dapm, ssm2604_routes,
561 ARRAY_SIZE(ssm2604_routes));
564 static int ssm260x_codec_probe(struct snd_soc_codec *codec)
566 struct ssm2602_priv *ssm2602 = snd_soc_codec_get_drvdata(codec);
569 ret = regmap_write(ssm2602->regmap, SSM2602_RESET, 0);
571 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
575 /* set the update bits */
576 regmap_update_bits(ssm2602->regmap, SSM2602_LINVOL,
577 LINVOL_LRIN_BOTH, LINVOL_LRIN_BOTH);
578 regmap_update_bits(ssm2602->regmap, SSM2602_RINVOL,
579 RINVOL_RLIN_BOTH, RINVOL_RLIN_BOTH);
580 /*select Line in as default input*/
581 regmap_write(ssm2602->regmap, SSM2602_APANA, APANA_SELECT_DAC |
582 APANA_ENABLE_MIC_BOOST);
584 switch (ssm2602->type) {
586 ret = ssm2602_codec_probe(codec);
589 ret = ssm2604_codec_probe(codec);
596 static struct snd_soc_codec_driver soc_codec_dev_ssm2602 = {
597 .probe = ssm260x_codec_probe,
598 .resume = ssm2602_resume,
599 .set_bias_level = ssm2602_set_bias_level,
600 .suspend_bias_off = true,
602 .controls = ssm260x_snd_controls,
603 .num_controls = ARRAY_SIZE(ssm260x_snd_controls),
604 .dapm_widgets = ssm260x_dapm_widgets,
605 .num_dapm_widgets = ARRAY_SIZE(ssm260x_dapm_widgets),
606 .dapm_routes = ssm260x_routes,
607 .num_dapm_routes = ARRAY_SIZE(ssm260x_routes),
610 static bool ssm2602_register_volatile(struct device *dev, unsigned int reg)
612 return reg == SSM2602_RESET;
615 const struct regmap_config ssm2602_regmap_config = {
619 .max_register = SSM2602_RESET,
620 .volatile_reg = ssm2602_register_volatile,
622 .cache_type = REGCACHE_RBTREE,
623 .reg_defaults_raw = ssm2602_reg,
624 .num_reg_defaults_raw = ARRAY_SIZE(ssm2602_reg),
626 EXPORT_SYMBOL_GPL(ssm2602_regmap_config);
628 int ssm2602_probe(struct device *dev, enum ssm2602_type type,
629 struct regmap *regmap)
631 struct ssm2602_priv *ssm2602;
634 return PTR_ERR(regmap);
636 ssm2602 = devm_kzalloc(dev, sizeof(*ssm2602), GFP_KERNEL);
640 dev_set_drvdata(dev, ssm2602);
641 ssm2602->type = type;
642 ssm2602->regmap = regmap;
644 return snd_soc_register_codec(dev, &soc_codec_dev_ssm2602,
647 EXPORT_SYMBOL_GPL(ssm2602_probe);
649 MODULE_DESCRIPTION("ASoC SSM2602/SSM2603/SSM2604 driver");
650 MODULE_AUTHOR("Cliff Cai");
651 MODULE_LICENSE("GPL");