4 * ASoC Driver for Cirrus Logic CS42L51 codecs
6 * Copyright (c) 2010 Arnaud Patard <apatard@mandriva.com>
8 * Based on cs4270.c - Copyright (c) Freescale Semiconductor
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
20 * - Only I2C is support. Not SPI
21 * - master mode *NOT* supported
24 #include <linux/module.h>
25 #include <linux/slab.h>
26 #include <sound/core.h>
27 #include <sound/soc.h>
28 #include <sound/tlv.h>
29 #include <sound/initval.h>
30 #include <sound/pcm_params.h>
31 #include <sound/pcm.h>
32 #include <linux/i2c.h>
33 #include <linux/regmap.h>
37 enum master_slave_mode {
43 struct cs42l51_private {
45 unsigned int audio_mode; /* The mode (I2S or left-justified) */
46 enum master_slave_mode func;
49 #define CS42L51_FORMATS ( \
50 SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S16_BE | \
51 SNDRV_PCM_FMTBIT_S18_3LE | SNDRV_PCM_FMTBIT_S18_3BE | \
52 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE | \
53 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S24_BE)
55 static int cs42l51_get_chan_mix(struct snd_kcontrol *kcontrol,
56 struct snd_ctl_elem_value *ucontrol)
58 struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
59 unsigned long value = snd_soc_read(codec, CS42L51_PCM_MIXER)&3;
64 ucontrol->value.integer.value[0] = 0;
66 /* same value : (L+R)/2 and (R+L)/2 */
69 ucontrol->value.integer.value[0] = 1;
72 ucontrol->value.integer.value[0] = 2;
79 #define CHAN_MIX_NORMAL 0x00
80 #define CHAN_MIX_BOTH 0x55
81 #define CHAN_MIX_SWAP 0xFF
83 static int cs42l51_set_chan_mix(struct snd_kcontrol *kcontrol,
84 struct snd_ctl_elem_value *ucontrol)
86 struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
89 switch (ucontrol->value.integer.value[0]) {
92 val = CHAN_MIX_NORMAL;
102 snd_soc_write(codec, CS42L51_PCM_MIXER, val);
107 static const DECLARE_TLV_DB_SCALE(adc_pcm_tlv, -5150, 50, 0);
108 static const DECLARE_TLV_DB_SCALE(tone_tlv, -1050, 150, 0);
110 static const DECLARE_TLV_DB_SCALE(aout_tlv, -10200, 50, 0);
112 static const DECLARE_TLV_DB_SCALE(boost_tlv, 1600, 1600, 0);
113 static const char *chan_mix[] = {
119 static SOC_ENUM_SINGLE_EXT_DECL(cs42l51_chan_mix, chan_mix);
121 static const struct snd_kcontrol_new cs42l51_snd_controls[] = {
122 SOC_DOUBLE_R_SX_TLV("PCM Playback Volume",
123 CS42L51_PCMA_VOL, CS42L51_PCMB_VOL,
124 0, 0x19, 0x7F, adc_pcm_tlv),
125 SOC_DOUBLE_R("PCM Playback Switch",
126 CS42L51_PCMA_VOL, CS42L51_PCMB_VOL, 7, 1, 1),
127 SOC_DOUBLE_R_SX_TLV("Analog Playback Volume",
128 CS42L51_AOUTA_VOL, CS42L51_AOUTB_VOL,
129 0, 0x34, 0xE4, aout_tlv),
130 SOC_DOUBLE_R_SX_TLV("ADC Mixer Volume",
131 CS42L51_ADCA_VOL, CS42L51_ADCB_VOL,
132 0, 0x19, 0x7F, adc_pcm_tlv),
133 SOC_DOUBLE_R("ADC Mixer Switch",
134 CS42L51_ADCA_VOL, CS42L51_ADCB_VOL, 7, 1, 1),
135 SOC_SINGLE("Playback Deemphasis Switch", CS42L51_DAC_CTL, 3, 1, 0),
136 SOC_SINGLE("Auto-Mute Switch", CS42L51_DAC_CTL, 2, 1, 0),
137 SOC_SINGLE("Soft Ramp Switch", CS42L51_DAC_CTL, 1, 1, 0),
138 SOC_SINGLE("Zero Cross Switch", CS42L51_DAC_CTL, 0, 0, 0),
139 SOC_DOUBLE_TLV("Mic Boost Volume",
140 CS42L51_MIC_CTL, 0, 1, 1, 0, boost_tlv),
141 SOC_SINGLE_TLV("Bass Volume", CS42L51_TONE_CTL, 0, 0xf, 1, tone_tlv),
142 SOC_SINGLE_TLV("Treble Volume", CS42L51_TONE_CTL, 4, 0xf, 1, tone_tlv),
143 SOC_ENUM_EXT("PCM channel mixer",
145 cs42l51_get_chan_mix, cs42l51_set_chan_mix),
149 * to power down, one must:
150 * 1.) Enable the PDN bit
151 * 2.) enable power-down for the select channels
152 * 3.) disable the PDN bit.
154 static int cs42l51_pdn_event(struct snd_soc_dapm_widget *w,
155 struct snd_kcontrol *kcontrol, int event)
158 case SND_SOC_DAPM_PRE_PMD:
159 snd_soc_update_bits(w->codec, CS42L51_POWER_CTL1,
160 CS42L51_POWER_CTL1_PDN,
161 CS42L51_POWER_CTL1_PDN);
164 case SND_SOC_DAPM_POST_PMD:
165 snd_soc_update_bits(w->codec, CS42L51_POWER_CTL1,
166 CS42L51_POWER_CTL1_PDN, 0);
173 static const char *cs42l51_dac_names[] = {"Direct PCM",
175 static SOC_ENUM_SINGLE_DECL(cs42l51_dac_mux_enum,
176 CS42L51_DAC_CTL, 6, cs42l51_dac_names);
177 static const struct snd_kcontrol_new cs42l51_dac_mux_controls =
178 SOC_DAPM_ENUM("Route", cs42l51_dac_mux_enum);
180 static const char *cs42l51_adcl_names[] = {"AIN1 Left", "AIN2 Left",
181 "MIC Left", "MIC+preamp Left"};
182 static SOC_ENUM_SINGLE_DECL(cs42l51_adcl_mux_enum,
183 CS42L51_ADC_INPUT, 4, cs42l51_adcl_names);
184 static const struct snd_kcontrol_new cs42l51_adcl_mux_controls =
185 SOC_DAPM_ENUM("Route", cs42l51_adcl_mux_enum);
187 static const char *cs42l51_adcr_names[] = {"AIN1 Right", "AIN2 Right",
188 "MIC Right", "MIC+preamp Right"};
189 static SOC_ENUM_SINGLE_DECL(cs42l51_adcr_mux_enum,
190 CS42L51_ADC_INPUT, 6, cs42l51_adcr_names);
191 static const struct snd_kcontrol_new cs42l51_adcr_mux_controls =
192 SOC_DAPM_ENUM("Route", cs42l51_adcr_mux_enum);
194 static const struct snd_soc_dapm_widget cs42l51_dapm_widgets[] = {
195 SND_SOC_DAPM_MICBIAS("Mic Bias", CS42L51_MIC_POWER_CTL, 1, 1),
196 SND_SOC_DAPM_PGA_E("Left PGA", CS42L51_POWER_CTL1, 3, 1, NULL, 0,
197 cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
198 SND_SOC_DAPM_PGA_E("Right PGA", CS42L51_POWER_CTL1, 4, 1, NULL, 0,
199 cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
200 SND_SOC_DAPM_ADC_E("Left ADC", "Left HiFi Capture",
201 CS42L51_POWER_CTL1, 1, 1,
202 cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
203 SND_SOC_DAPM_ADC_E("Right ADC", "Right HiFi Capture",
204 CS42L51_POWER_CTL1, 2, 1,
205 cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
206 SND_SOC_DAPM_DAC_E("Left DAC", "Left HiFi Playback",
207 CS42L51_POWER_CTL1, 5, 1,
208 cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
209 SND_SOC_DAPM_DAC_E("Right DAC", "Right HiFi Playback",
210 CS42L51_POWER_CTL1, 6, 1,
211 cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
214 SND_SOC_DAPM_INPUT("AIN1L"),
215 SND_SOC_DAPM_INPUT("AIN1R"),
216 SND_SOC_DAPM_INPUT("AIN2L"),
217 SND_SOC_DAPM_INPUT("AIN2R"),
218 SND_SOC_DAPM_INPUT("MICL"),
219 SND_SOC_DAPM_INPUT("MICR"),
221 SND_SOC_DAPM_MIXER("Mic Preamp Left",
222 CS42L51_MIC_POWER_CTL, 2, 1, NULL, 0),
223 SND_SOC_DAPM_MIXER("Mic Preamp Right",
224 CS42L51_MIC_POWER_CTL, 3, 1, NULL, 0),
227 SND_SOC_DAPM_OUTPUT("HPL"),
228 SND_SOC_DAPM_OUTPUT("HPR"),
231 SND_SOC_DAPM_MUX("DAC Mux", SND_SOC_NOPM, 0, 0,
232 &cs42l51_dac_mux_controls),
233 SND_SOC_DAPM_MUX("PGA-ADC Mux Left", SND_SOC_NOPM, 0, 0,
234 &cs42l51_adcl_mux_controls),
235 SND_SOC_DAPM_MUX("PGA-ADC Mux Right", SND_SOC_NOPM, 0, 0,
236 &cs42l51_adcr_mux_controls),
239 static const struct snd_soc_dapm_route cs42l51_routes[] = {
240 {"HPL", NULL, "Left DAC"},
241 {"HPR", NULL, "Right DAC"},
243 {"Left ADC", NULL, "Left PGA"},
244 {"Right ADC", NULL, "Right PGA"},
246 {"Mic Preamp Left", NULL, "MICL"},
247 {"Mic Preamp Right", NULL, "MICR"},
249 {"PGA-ADC Mux Left", "AIN1 Left", "AIN1L" },
250 {"PGA-ADC Mux Left", "AIN2 Left", "AIN2L" },
251 {"PGA-ADC Mux Left", "MIC Left", "MICL" },
252 {"PGA-ADC Mux Left", "MIC+preamp Left", "Mic Preamp Left" },
253 {"PGA-ADC Mux Right", "AIN1 Right", "AIN1R" },
254 {"PGA-ADC Mux Right", "AIN2 Right", "AIN2R" },
255 {"PGA-ADC Mux Right", "MIC Right", "MICR" },
256 {"PGA-ADC Mux Right", "MIC+preamp Right", "Mic Preamp Right" },
258 {"Left PGA", NULL, "PGA-ADC Mux Left"},
259 {"Right PGA", NULL, "PGA-ADC Mux Right"},
262 static int cs42l51_set_dai_fmt(struct snd_soc_dai *codec_dai,
265 struct snd_soc_codec *codec = codec_dai->codec;
266 struct cs42l51_private *cs42l51 = snd_soc_codec_get_drvdata(codec);
268 switch (format & SND_SOC_DAIFMT_FORMAT_MASK) {
269 case SND_SOC_DAIFMT_I2S:
270 case SND_SOC_DAIFMT_LEFT_J:
271 case SND_SOC_DAIFMT_RIGHT_J:
272 cs42l51->audio_mode = format & SND_SOC_DAIFMT_FORMAT_MASK;
275 dev_err(codec->dev, "invalid DAI format\n");
279 switch (format & SND_SOC_DAIFMT_MASTER_MASK) {
280 case SND_SOC_DAIFMT_CBM_CFM:
281 cs42l51->func = MODE_MASTER;
283 case SND_SOC_DAIFMT_CBS_CFS:
284 cs42l51->func = MODE_SLAVE_AUTO;
287 dev_err(codec->dev, "Unknown master/slave configuration\n");
294 struct cs42l51_ratios {
296 unsigned char speed_mode;
300 static struct cs42l51_ratios slave_ratios[] = {
301 { 512, CS42L51_QSM_MODE, 0 }, { 768, CS42L51_QSM_MODE, 0 },
302 { 1024, CS42L51_QSM_MODE, 0 }, { 1536, CS42L51_QSM_MODE, 0 },
303 { 2048, CS42L51_QSM_MODE, 0 }, { 3072, CS42L51_QSM_MODE, 0 },
304 { 256, CS42L51_HSM_MODE, 0 }, { 384, CS42L51_HSM_MODE, 0 },
305 { 512, CS42L51_HSM_MODE, 0 }, { 768, CS42L51_HSM_MODE, 0 },
306 { 1024, CS42L51_HSM_MODE, 0 }, { 1536, CS42L51_HSM_MODE, 0 },
307 { 128, CS42L51_SSM_MODE, 0 }, { 192, CS42L51_SSM_MODE, 0 },
308 { 256, CS42L51_SSM_MODE, 0 }, { 384, CS42L51_SSM_MODE, 0 },
309 { 512, CS42L51_SSM_MODE, 0 }, { 768, CS42L51_SSM_MODE, 0 },
310 { 128, CS42L51_DSM_MODE, 0 }, { 192, CS42L51_DSM_MODE, 0 },
311 { 256, CS42L51_DSM_MODE, 0 }, { 384, CS42L51_DSM_MODE, 0 },
314 static struct cs42l51_ratios slave_auto_ratios[] = {
315 { 1024, CS42L51_QSM_MODE, 0 }, { 1536, CS42L51_QSM_MODE, 0 },
316 { 2048, CS42L51_QSM_MODE, 1 }, { 3072, CS42L51_QSM_MODE, 1 },
317 { 512, CS42L51_HSM_MODE, 0 }, { 768, CS42L51_HSM_MODE, 0 },
318 { 1024, CS42L51_HSM_MODE, 1 }, { 1536, CS42L51_HSM_MODE, 1 },
319 { 256, CS42L51_SSM_MODE, 0 }, { 384, CS42L51_SSM_MODE, 0 },
320 { 512, CS42L51_SSM_MODE, 1 }, { 768, CS42L51_SSM_MODE, 1 },
321 { 128, CS42L51_DSM_MODE, 0 }, { 192, CS42L51_DSM_MODE, 0 },
322 { 256, CS42L51_DSM_MODE, 1 }, { 384, CS42L51_DSM_MODE, 1 },
325 static int cs42l51_set_dai_sysclk(struct snd_soc_dai *codec_dai,
326 int clk_id, unsigned int freq, int dir)
328 struct snd_soc_codec *codec = codec_dai->codec;
329 struct cs42l51_private *cs42l51 = snd_soc_codec_get_drvdata(codec);
331 cs42l51->mclk = freq;
335 static int cs42l51_hw_params(struct snd_pcm_substream *substream,
336 struct snd_pcm_hw_params *params,
337 struct snd_soc_dai *dai)
339 struct snd_soc_codec *codec = dai->codec;
340 struct cs42l51_private *cs42l51 = snd_soc_codec_get_drvdata(codec);
345 struct cs42l51_ratios *ratios = NULL;
347 int intf_ctl, power_ctl, fmt;
349 switch (cs42l51->func) {
353 ratios = slave_ratios;
354 nr_ratios = ARRAY_SIZE(slave_ratios);
356 case MODE_SLAVE_AUTO:
357 ratios = slave_auto_ratios;
358 nr_ratios = ARRAY_SIZE(slave_auto_ratios);
362 /* Figure out which MCLK/LRCK ratio to use */
363 rate = params_rate(params); /* Sampling rate, in Hz */
364 ratio = cs42l51->mclk / rate; /* MCLK/LRCK ratio */
365 for (i = 0; i < nr_ratios; i++) {
366 if (ratios[i].ratio == ratio)
370 if (i == nr_ratios) {
371 /* We did not find a matching ratio */
372 dev_err(codec->dev, "could not find matching ratio\n");
376 intf_ctl = snd_soc_read(codec, CS42L51_INTF_CTL);
377 power_ctl = snd_soc_read(codec, CS42L51_MIC_POWER_CTL);
379 intf_ctl &= ~(CS42L51_INTF_CTL_MASTER | CS42L51_INTF_CTL_ADC_I2S
380 | CS42L51_INTF_CTL_DAC_FORMAT(7));
381 power_ctl &= ~(CS42L51_MIC_POWER_CTL_SPEED(3)
382 | CS42L51_MIC_POWER_CTL_MCLK_DIV2);
384 switch (cs42l51->func) {
386 intf_ctl |= CS42L51_INTF_CTL_MASTER;
387 power_ctl |= CS42L51_MIC_POWER_CTL_SPEED(ratios[i].speed_mode);
390 power_ctl |= CS42L51_MIC_POWER_CTL_SPEED(ratios[i].speed_mode);
392 case MODE_SLAVE_AUTO:
393 power_ctl |= CS42L51_MIC_POWER_CTL_AUTO;
397 switch (cs42l51->audio_mode) {
398 case SND_SOC_DAIFMT_I2S:
399 intf_ctl |= CS42L51_INTF_CTL_ADC_I2S;
400 intf_ctl |= CS42L51_INTF_CTL_DAC_FORMAT(CS42L51_DAC_DIF_I2S);
402 case SND_SOC_DAIFMT_LEFT_J:
403 intf_ctl |= CS42L51_INTF_CTL_DAC_FORMAT(CS42L51_DAC_DIF_LJ24);
405 case SND_SOC_DAIFMT_RIGHT_J:
406 switch (params_width(params)) {
408 fmt = CS42L51_DAC_DIF_RJ16;
411 fmt = CS42L51_DAC_DIF_RJ18;
414 fmt = CS42L51_DAC_DIF_RJ20;
417 fmt = CS42L51_DAC_DIF_RJ24;
420 dev_err(codec->dev, "unknown format\n");
423 intf_ctl |= CS42L51_INTF_CTL_DAC_FORMAT(fmt);
426 dev_err(codec->dev, "unknown format\n");
431 power_ctl |= CS42L51_MIC_POWER_CTL_MCLK_DIV2;
433 ret = snd_soc_write(codec, CS42L51_INTF_CTL, intf_ctl);
437 ret = snd_soc_write(codec, CS42L51_MIC_POWER_CTL, power_ctl);
444 static int cs42l51_dai_mute(struct snd_soc_dai *dai, int mute)
446 struct snd_soc_codec *codec = dai->codec;
448 int mask = CS42L51_DAC_OUT_CTL_DACA_MUTE|CS42L51_DAC_OUT_CTL_DACB_MUTE;
450 reg = snd_soc_read(codec, CS42L51_DAC_OUT_CTL);
457 return snd_soc_write(codec, CS42L51_DAC_OUT_CTL, reg);
460 static const struct snd_soc_dai_ops cs42l51_dai_ops = {
461 .hw_params = cs42l51_hw_params,
462 .set_sysclk = cs42l51_set_dai_sysclk,
463 .set_fmt = cs42l51_set_dai_fmt,
464 .digital_mute = cs42l51_dai_mute,
467 static struct snd_soc_dai_driver cs42l51_dai = {
468 .name = "cs42l51-hifi",
470 .stream_name = "Playback",
473 .rates = SNDRV_PCM_RATE_8000_96000,
474 .formats = CS42L51_FORMATS,
477 .stream_name = "Capture",
480 .rates = SNDRV_PCM_RATE_8000_96000,
481 .formats = CS42L51_FORMATS,
483 .ops = &cs42l51_dai_ops,
486 static int cs42l51_probe(struct snd_soc_codec *codec)
492 * - Use signal processor
494 * - vol changes immediate
497 reg = CS42L51_DAC_CTL_DATA_SEL(1)
498 | CS42L51_DAC_CTL_AMUTE | CS42L51_DAC_CTL_DACSZ(0);
499 ret = snd_soc_write(codec, CS42L51_DAC_CTL, reg);
506 static struct snd_soc_codec_driver soc_codec_device_cs42l51 = {
507 .probe = cs42l51_probe,
509 .controls = cs42l51_snd_controls,
510 .num_controls = ARRAY_SIZE(cs42l51_snd_controls),
511 .dapm_widgets = cs42l51_dapm_widgets,
512 .num_dapm_widgets = ARRAY_SIZE(cs42l51_dapm_widgets),
513 .dapm_routes = cs42l51_routes,
514 .num_dapm_routes = ARRAY_SIZE(cs42l51_routes),
517 static const struct regmap_config cs42l51_regmap = {
521 .max_register = CS42L51_CHARGE_FREQ,
522 .cache_type = REGCACHE_RBTREE,
525 static int cs42l51_i2c_probe(struct i2c_client *i2c_client,
526 const struct i2c_device_id *id)
528 struct cs42l51_private *cs42l51;
529 struct regmap *regmap;
533 regmap = devm_regmap_init_i2c(i2c_client, &cs42l51_regmap);
534 if (IS_ERR(regmap)) {
535 ret = PTR_ERR(regmap);
536 dev_err(&i2c_client->dev, "Failed to create regmap: %d\n",
541 /* Verify that we have a CS42L51 */
542 ret = regmap_read(regmap, CS42L51_CHIP_REV_ID, &val);
544 dev_err(&i2c_client->dev, "failed to read I2C\n");
548 if ((val != CS42L51_MK_CHIP_REV(CS42L51_CHIP_ID, CS42L51_CHIP_REV_A)) &&
549 (val != CS42L51_MK_CHIP_REV(CS42L51_CHIP_ID, CS42L51_CHIP_REV_B))) {
550 dev_err(&i2c_client->dev, "Invalid chip id: %x\n", val);
555 dev_info(&i2c_client->dev, "found device cs42l51 rev %d\n",
558 cs42l51 = devm_kzalloc(&i2c_client->dev, sizeof(struct cs42l51_private),
563 i2c_set_clientdata(i2c_client, cs42l51);
565 ret = snd_soc_register_codec(&i2c_client->dev,
566 &soc_codec_device_cs42l51, &cs42l51_dai, 1);
571 static int cs42l51_i2c_remove(struct i2c_client *client)
573 snd_soc_unregister_codec(&client->dev);
577 static const struct i2c_device_id cs42l51_id[] = {
581 MODULE_DEVICE_TABLE(i2c, cs42l51_id);
583 static const struct of_device_id cs42l51_of_match[] = {
584 { .compatible = "cirrus,cs42l51", },
587 MODULE_DEVICE_TABLE(of, cs42l51_of_match);
589 static struct i2c_driver cs42l51_i2c_driver = {
591 .name = "cs42l51-codec",
592 .owner = THIS_MODULE,
593 .of_match_table = cs42l51_of_match,
595 .id_table = cs42l51_id,
596 .probe = cs42l51_i2c_probe,
597 .remove = cs42l51_i2c_remove,
600 module_i2c_driver(cs42l51_i2c_driver);
602 MODULE_AUTHOR("Arnaud Patard <arnaud.patard@rtp-net.org>");
603 MODULE_DESCRIPTION("Cirrus Logic CS42L51 ALSA SoC Codec Driver");
604 MODULE_LICENSE("GPL");