2 * File: sound/soc/codecs/ad1938.c
3 * Author: Barry Song <Barry.Song@analog.com>
5 * Created: June 04 2009
6 * Description: Driver for AD1938 sound chip
9 * Copyright 2009 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/init.h>
30 #include <linux/module.h>
31 #include <linux/version.h>
32 #include <linux/kernel.h>
33 #include <linux/device.h>
34 #include <sound/core.h>
35 #include <sound/pcm.h>
36 #include <sound/pcm_params.h>
37 #include <sound/initval.h>
38 #include <sound/soc.h>
39 #include <sound/tlv.h>
40 #include <sound/soc-dapm.h>
41 #include <linux/spi/spi.h>
44 /* codec private data */
46 struct snd_soc_codec codec;
47 u8 reg_cache[AD1938_NUM_REGS];
51 static struct snd_soc_codec *ad1938_codec;
52 struct snd_soc_codec_device soc_codec_dev_ad1938;
53 static int ad1938_register(struct ad1938_priv *ad1938);
54 static void ad1938_unregister(struct ad1938_priv *ad1938);
57 * AD1938 volume/mute/de-emphasis etc. controls
59 static const char *ad1938_deemp[] = {"None", "48kHz", "44.1kHz", "32kHz"};
61 static const struct soc_enum ad1938_deemp_enum =
62 SOC_ENUM_SINGLE(AD1938_DAC_CTRL2, 1, 4, ad1938_deemp);
64 static const struct snd_kcontrol_new ad1938_snd_controls[] = {
65 /* DAC volume control */
66 SOC_DOUBLE_R("DAC1 Volume", AD1938_DAC_L1_VOL,
67 AD1938_DAC_R1_VOL, 0, 0xFF, 1),
68 SOC_DOUBLE_R("DAC2 Volume", AD1938_DAC_L2_VOL,
69 AD1938_DAC_R2_VOL, 0, 0xFF, 1),
70 SOC_DOUBLE_R("DAC3 Volume", AD1938_DAC_L3_VOL,
71 AD1938_DAC_R3_VOL, 0, 0xFF, 1),
72 SOC_DOUBLE_R("DAC4 Volume", AD1938_DAC_L4_VOL,
73 AD1938_DAC_R4_VOL, 0, 0xFF, 1),
75 /* ADC switch control */
76 SOC_DOUBLE("ADC1 Switch", AD1938_ADC_CTRL0, AD1938_ADCL1_MUTE, AD1938_ADCR1_MUTE, 1, 1),
77 SOC_DOUBLE("ADC2 Switch", AD1938_ADC_CTRL0, AD1938_ADCL2_MUTE, AD1938_ADCR2_MUTE, 1, 1),
79 /* DAC switch control */
80 SOC_DOUBLE("DAC1 Switch", AD1938_DAC_CHNL_MUTE, AD1938_DACL1_MUTE, AD1938_DACR1_MUTE, 1, 1),
81 SOC_DOUBLE("DAC2 Switch", AD1938_DAC_CHNL_MUTE, AD1938_DACL2_MUTE, AD1938_DACR2_MUTE, 1, 1),
82 SOC_DOUBLE("DAC3 Switch", AD1938_DAC_CHNL_MUTE, AD1938_DACL3_MUTE, AD1938_DACR3_MUTE, 1, 1),
83 SOC_DOUBLE("DAC4 Switch", AD1938_DAC_CHNL_MUTE, AD1938_DACL4_MUTE, AD1938_DACR4_MUTE, 1, 1),
85 /* ADC high-pass filter */
86 SOC_SINGLE("ADC High Pass Filter Switch", AD1938_ADC_CTRL0,
87 AD1938_ADC_HIGHPASS_FILTER, 1, 0),
90 SOC_ENUM("Playback Deemphasis", ad1938_deemp_enum),
93 static const struct snd_soc_dapm_widget ad1938_dapm_widgets[] = {
94 SND_SOC_DAPM_DAC("DAC", "Playback", AD1938_DAC_CTRL0, 0, 1),
95 SND_SOC_DAPM_ADC("ADC", "Capture", SND_SOC_NOPM, 0, 0),
96 SND_SOC_DAPM_SUPPLY("ADC_PWR", AD1938_ADC_CTRL0, 0, 1, NULL, 0),
99 static const struct snd_soc_dapm_route audio_paths[] = {
100 { "DAC", NULL, "ADC_PWR" },
101 { "ADC", NULL, "ADC_PWR" },
108 static int ad1938_mute(struct snd_soc_dai *dai, int mute)
110 struct snd_soc_codec *codec = dai->codec;
113 reg = codec->read(codec, AD1938_DAC_CTRL2);
114 reg = (mute > 0) ? reg | AD1938_DAC_MASTER_MUTE : reg & (~AD1938_DAC_MASTER_MUTE);
115 codec->write(codec, AD1938_DAC_CTRL2, reg);
120 static inline int ad1938_pll_powerctrl(struct snd_soc_codec *codec, int cmd)
122 int reg = codec->read(codec, AD1938_PLL_CLK_CTRL0);
123 reg = (cmd > 0) ? reg & (~AD1938_PLL_POWERDOWN) : reg | AD1938_PLL_POWERDOWN;
124 codec->write(codec, AD1938_PLL_CLK_CTRL0, reg);
129 static int ad1938_set_tdm_slot(struct snd_soc_dai *dai,
130 unsigned int mask, int slots)
132 struct snd_soc_codec *codec = dai->codec;
133 int dac_reg = codec->read(codec, AD1938_DAC_CTRL1);
134 int adc_reg = codec->read(codec, AD1938_ADC_CTRL2);
136 dac_reg &= ~AD1938_DAC_CHAN_MASK;
137 adc_reg &= ~AD1938_ADC_CHAN_MASK;
141 dac_reg |= AD1938_DAC_2_CHANNELS << AD1938_DAC_CHAN_SHFT;
142 adc_reg |= AD1938_ADC_2_CHANNELS << AD1938_ADC_CHAN_SHFT;
145 dac_reg |= AD1938_DAC_4_CHANNELS << AD1938_DAC_CHAN_SHFT;
146 adc_reg |= AD1938_ADC_4_CHANNELS << AD1938_ADC_CHAN_SHFT;
149 dac_reg |= AD1938_DAC_8_CHANNELS << AD1938_DAC_CHAN_SHFT;
150 adc_reg |= AD1938_ADC_8_CHANNELS << AD1938_ADC_CHAN_SHFT;
153 dac_reg |= AD1938_DAC_16_CHANNELS << AD1938_DAC_CHAN_SHFT;
154 adc_reg |= AD1938_ADC_16_CHANNELS << AD1938_ADC_CHAN_SHFT;
160 codec->write(codec, AD1938_DAC_CTRL1, dac_reg);
161 codec->write(codec, AD1938_ADC_CTRL2, adc_reg);
166 static int ad1938_set_dai_fmt(struct snd_soc_dai *codec_dai,
169 struct snd_soc_codec *codec = codec_dai->codec;
170 int adc_reg, dac_reg;
172 adc_reg = codec->read(codec, AD1938_ADC_CTRL2);
173 dac_reg = codec->read(codec, AD1938_DAC_CTRL1);
175 /* At present, the driver only support AUX ADC mode(SND_SOC_DAIFMT_I2S with TDM)
176 * and ADC&DAC TDM mode(SND_SOC_DAIFMT_DSP_A)
178 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
179 case SND_SOC_DAIFMT_I2S:
180 adc_reg &= ~AD1938_ADC_SERFMT_MASK;
181 adc_reg |= AD1938_ADC_SERFMT_TDM;
183 case SND_SOC_DAIFMT_DSP_A:
184 adc_reg &= ~AD1938_ADC_SERFMT_MASK;
185 adc_reg |= AD1938_ADC_SERFMT_AUX;
191 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
192 case SND_SOC_DAIFMT_NB_NF: /* normal bit clock + frame */
193 adc_reg &= ~AD1938_ADC_LEFT_HIGH;
194 adc_reg &= ~AD1938_ADC_BCLK_INV;
195 dac_reg &= ~AD1938_DAC_LEFT_HIGH;
196 dac_reg &= ~AD1938_DAC_BCLK_INV;
198 case SND_SOC_DAIFMT_NB_IF: /* normal bclk + invert frm */
199 adc_reg |= AD1938_ADC_LEFT_HIGH;
200 adc_reg &= ~AD1938_ADC_BCLK_INV;
201 dac_reg |= AD1938_DAC_LEFT_HIGH;
202 dac_reg &= ~AD1938_DAC_BCLK_INV;
204 case SND_SOC_DAIFMT_IB_NF: /* invert bclk + normal frm */
205 adc_reg &= ~AD1938_ADC_LEFT_HIGH;
206 adc_reg |= AD1938_ADC_BCLK_INV;
207 dac_reg &= ~AD1938_DAC_LEFT_HIGH;
208 dac_reg |= AD1938_DAC_BCLK_INV;
211 case SND_SOC_DAIFMT_IB_IF: /* invert bclk + frm */
212 adc_reg |= AD1938_ADC_LEFT_HIGH;
213 adc_reg |= AD1938_ADC_BCLK_INV;
214 dac_reg |= AD1938_DAC_LEFT_HIGH;
215 dac_reg |= AD1938_DAC_BCLK_INV;
221 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
222 case SND_SOC_DAIFMT_CBM_CFM: /* codec clk & frm master */
223 adc_reg |= AD1938_ADC_LCR_MASTER;
224 adc_reg |= AD1938_ADC_BCLK_MASTER;
225 dac_reg |= AD1938_DAC_LCR_MASTER;
226 dac_reg |= AD1938_DAC_BCLK_MASTER;
228 case SND_SOC_DAIFMT_CBS_CFM: /* codec clk slave & frm master */
229 adc_reg |= AD1938_ADC_LCR_MASTER;
230 adc_reg &= ~AD1938_ADC_BCLK_MASTER;
231 dac_reg |= AD1938_DAC_LCR_MASTER;
232 dac_reg &= ~AD1938_DAC_BCLK_MASTER;
234 case SND_SOC_DAIFMT_CBM_CFS: /* codec clk master & frame slave */
235 adc_reg &= ~AD1938_ADC_LCR_MASTER;
236 adc_reg |= AD1938_ADC_BCLK_MASTER;
237 dac_reg &= ~AD1938_DAC_LCR_MASTER;
238 dac_reg |= AD1938_DAC_BCLK_MASTER;
240 case SND_SOC_DAIFMT_CBS_CFS: /* codec clk & frm slave */
241 adc_reg &= ~AD1938_ADC_LCR_MASTER;
242 adc_reg &= ~AD1938_ADC_BCLK_MASTER;
243 dac_reg &= ~AD1938_DAC_LCR_MASTER;
244 dac_reg &= ~AD1938_DAC_BCLK_MASTER;
250 codec->write(codec, AD1938_ADC_CTRL2, adc_reg);
251 codec->write(codec, AD1938_DAC_CTRL1, dac_reg);
256 static int ad1938_hw_params(struct snd_pcm_substream *substream,
257 struct snd_pcm_hw_params *params,
258 struct snd_soc_dai *dai)
260 int word_len = 0, reg = 0;
262 struct snd_soc_pcm_runtime *rtd = substream->private_data;
263 struct snd_soc_device *socdev = rtd->socdev;
264 struct snd_soc_codec *codec = socdev->card->codec;
267 switch (params_format(params)) {
268 case SNDRV_PCM_FORMAT_S16_LE:
271 case SNDRV_PCM_FORMAT_S20_3LE:
274 case SNDRV_PCM_FORMAT_S24_LE:
275 case SNDRV_PCM_FORMAT_S32_LE:
280 reg = codec->read(codec, AD1938_DAC_CTRL2);
281 reg = (reg & (~AD1938_DAC_WORD_LEN_MASK)) | word_len;
282 codec->write(codec, AD1938_DAC_CTRL2, reg);
284 reg = codec->read(codec, AD1938_ADC_CTRL1);
285 reg = (reg & (~AD1938_ADC_WORD_LEN_MASK)) | word_len;
286 codec->write(codec, AD1938_ADC_CTRL1, reg);
291 static int ad1938_set_bias_level(struct snd_soc_codec *codec,
292 enum snd_soc_bias_level level)
295 case SND_SOC_BIAS_ON:
296 ad1938_pll_powerctrl(codec, 1);
298 case SND_SOC_BIAS_PREPARE:
300 case SND_SOC_BIAS_STANDBY:
301 case SND_SOC_BIAS_OFF:
302 ad1938_pll_powerctrl(codec, 0);
305 codec->bias_level = level;
310 * interface to read/write ad1938 register
313 #define AD1938_SPI_ADDR 0x4
314 #define AD1938_SPI_READ 0x1
315 #define AD1938_SPI_BUFLEN 3
318 * write to the ad1938 register space
321 static int ad1938_write_reg(struct snd_soc_codec *codec, unsigned int reg,
324 u8 *reg_cache = codec->reg_cache;
327 if(value != reg_cache[reg]) {
328 uint8_t buf[AD1938_SPI_BUFLEN];
329 struct spi_transfer t = {
331 .len = AD1938_SPI_BUFLEN,
333 struct spi_message m;
335 buf[0] = AD1938_SPI_ADDR << 1;
338 spi_message_init(&m);
339 spi_message_add_tail(&t, &m);
340 if((ret = spi_sync(codec->control_data, &m)) == 0)
341 reg_cache[reg] = value;
348 * read from the ad1938 register space cache
351 static unsigned int ad1938_read_reg_cache(struct snd_soc_codec *codec,
354 u8 *reg_cache = codec->reg_cache;
356 if (reg >= codec->reg_cache_size)
359 return reg_cache[reg];
363 * read from the ad1938 register space
366 static unsigned int ad1938_read_reg(struct snd_soc_codec *codec, unsigned int reg)
368 char w_buf[AD1938_SPI_BUFLEN];
369 char r_buf[AD1938_SPI_BUFLEN];
372 struct spi_transfer t = {
375 .len = AD1938_SPI_BUFLEN,
377 struct spi_message m;
379 w_buf[0] = (AD1938_SPI_ADDR << 1) | AD1938_SPI_READ;
383 spi_message_init(&m);
384 spi_message_add_tail(&t, &m);
385 ret = spi_sync(codec->control_data, &m);
392 static int ad1938_fill_cache(struct snd_soc_codec *codec)
395 u8 *reg_cache = codec->reg_cache;
396 struct spi_device *spi = codec->control_data;
398 for (i = 0; i < codec->reg_cache_size; i++) {
399 int ret = ad1938_read_reg(codec, i);
401 dev_err(&spi->dev, "AD1938 SPI read failure\n");
410 static int __devinit ad1938_spi_probe(struct spi_device *spi)
412 struct snd_soc_codec *codec;
413 struct ad1938_priv *ad1938;
415 ad1938 = kzalloc(sizeof(struct ad1938_priv), GFP_KERNEL);
419 codec = &ad1938->codec;
420 codec->control_data = spi;
421 codec->dev = &spi->dev;
423 spi->dev.driver_data = ad1938;
425 return ad1938_register(ad1938);
428 static int __devexit ad1938_spi_remove(struct spi_device *spi)
430 struct ad1938_priv *ad1938 = spi->dev.driver_data;
432 ad1938_unregister(ad1938);
436 static struct spi_driver ad1938_spi_driver = {
438 .name = "ad1938-spi",
439 .bus = &spi_bus_type,
440 .owner = THIS_MODULE,
442 .probe = ad1938_spi_probe,
443 .remove = __devexit_p(ad1938_spi_remove),
446 static struct snd_soc_dai_ops ad1938_dai_ops = {
447 .hw_params = ad1938_hw_params,
448 .digital_mute = ad1938_mute,
449 .set_tdm_slot = ad1938_set_tdm_slot,
450 .set_fmt = ad1938_set_dai_fmt,
453 /* codec DAI instance */
454 struct snd_soc_dai ad1938_dai = {
457 .stream_name = "Playback",
460 .rates = SNDRV_PCM_RATE_48000,
461 .formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
462 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
465 .stream_name = "Capture",
468 .rates = SNDRV_PCM_RATE_48000,
469 .formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
470 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
472 .ops = &ad1938_dai_ops,
474 EXPORT_SYMBOL_GPL(ad1938_dai);
476 static int ad1938_register(struct ad1938_priv *ad1938)
479 struct snd_soc_codec *codec = &ad1938->codec;
482 dev_err(codec->dev, "Another ad1938 is registered\n");
486 mutex_init(&codec->mutex);
487 INIT_LIST_HEAD(&codec->dapm_widgets);
488 INIT_LIST_HEAD(&codec->dapm_paths);
489 codec->private_data = ad1938;
490 codec->reg_cache = ad1938->reg_cache;
491 codec->reg_cache_size = AD1938_NUM_REGS;
492 codec->name = "AD1938";
493 codec->owner = THIS_MODULE;
494 codec->dai = &ad1938_dai;
496 codec->write = ad1938_write_reg;
497 codec->read = ad1938_read_reg_cache;
498 INIT_LIST_HEAD(&codec->dapm_widgets);
499 INIT_LIST_HEAD(&codec->dapm_paths);
501 ad1938_dai.dev = codec->dev;
502 ad1938_codec = codec;
504 /* default setting for ad1938 */
505 codec->write(codec, AD1938_DAC_CHNL_MUTE, 0x0); /* unmute dac channels */
506 codec->write(codec, AD1938_DAC_CTRL2, 0x1A); /* de-emphasis: 48kHz, powedown dac */
507 codec->write(codec, AD1938_DAC_CTRL0, 0x21); /* powerdown dac, dac tdm mode */
508 codec->write(codec, AD1938_ADC_CTRL0, 0x3); /* high-pass filter enable */
509 codec->write(codec, AD1938_ADC_CTRL1, 0x43); /* sata delay=1, adc aux mode */
510 codec->write(codec, AD1938_PLL_CLK_CTRL0, 0x9D); /* pll input:mclki/xi */
511 codec->write(codec, AD1938_PLL_CLK_CTRL1, 0x04);
513 ad1938_fill_cache(codec);
515 ret = snd_soc_register_codec(codec);
517 dev_err(codec->dev, "Failed to register codec: %d\n", ret);
521 ret = snd_soc_register_dai(&ad1938_dai);
523 dev_err(codec->dev, "Failed to register DAI: %d\n", ret);
524 snd_soc_unregister_codec(codec);
531 static void ad1938_unregister(struct ad1938_priv *ad1938)
533 ad1938_set_bias_level(&ad1938->codec, SND_SOC_BIAS_OFF);
534 snd_soc_unregister_dai(&ad1938_dai);
535 snd_soc_unregister_codec(&ad1938->codec);
540 static int ad1938_probe(struct platform_device *pdev)
542 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
543 struct snd_soc_codec *codec;
546 if (ad1938_codec == NULL) {
547 dev_err(&pdev->dev, "Codec device not registered\n");
551 socdev->card->codec = ad1938_codec;
552 codec = ad1938_codec;
555 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
557 dev_err(codec->dev, "failed to create pcms: %d\n", ret);
561 snd_soc_add_controls(codec, ad1938_snd_controls,
562 ARRAY_SIZE(ad1938_snd_controls));
563 snd_soc_dapm_new_controls(codec, ad1938_dapm_widgets,
564 ARRAY_SIZE(ad1938_dapm_widgets));
565 snd_soc_dapm_add_routes(codec, audio_paths, ARRAY_SIZE(audio_paths));
566 snd_soc_dapm_new_widgets(codec);
568 ad1938_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
570 ret = snd_soc_init_card(socdev);
572 dev_err(codec->dev, "failed to register card: %d\n", ret);
579 snd_soc_free_pcms(socdev);
580 snd_soc_dapm_free(socdev);
585 /* power down chip */
586 static int ad1938_remove(struct platform_device *pdev)
588 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
590 snd_soc_free_pcms(socdev);
591 snd_soc_dapm_free(socdev);
597 static int ad1938_suspend(struct platform_device *pdev,
600 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
601 struct snd_soc_codec *codec = socdev->card->codec;
603 ad1938_set_bias_level(codec, SND_SOC_BIAS_OFF);
607 static int ad1938_resume(struct platform_device *pdev)
609 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
610 struct snd_soc_codec *codec = socdev->card->codec;
612 if (codec->suspend_bias_level == SND_SOC_BIAS_ON)
613 ad1938_set_bias_level(codec, SND_SOC_BIAS_ON);
618 #define ad1938_suspend NULL
619 #define ad1938_resume NULL
622 struct snd_soc_codec_device soc_codec_dev_ad1938 = {
623 .probe = ad1938_probe,
624 .remove = ad1938_remove,
625 .suspend = ad1938_suspend,
626 .resume = ad1938_resume,
628 EXPORT_SYMBOL_GPL(soc_codec_dev_ad1938);
630 static int __init ad1938_init(void)
634 ret = spi_register_driver(&ad1938_spi_driver);
636 printk(KERN_ERR "Failed to register ad1938 SPI driver: %d\n",
642 module_init(ad1938_init);
644 static void __exit ad1938_exit(void)
646 spi_unregister_driver(&ad1938_spi_driver);
648 module_exit(ad1938_exit);
650 MODULE_DESCRIPTION("ASoC ad1938 driver");
651 MODULE_AUTHOR("Barry Song ");
652 MODULE_LICENSE("GPL");