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/kernel.h>
32 #include <linux/device.h>
33 #include <sound/core.h>
34 #include <sound/pcm.h>
35 #include <sound/pcm_params.h>
36 #include <sound/initval.h>
37 #include <sound/soc.h>
38 #include <sound/tlv.h>
39 #include <sound/soc-dapm.h>
40 #include <linux/spi/spi.h>
43 /* codec private data */
45 struct snd_soc_codec codec;
46 u8 reg_cache[AD1938_NUM_REGS];
49 static struct snd_soc_codec *ad1938_codec;
50 struct snd_soc_codec_device soc_codec_dev_ad1938;
51 static int ad1938_register(struct ad1938_priv *ad1938);
52 static void ad1938_unregister(struct ad1938_priv *ad1938);
55 * AD1938 volume/mute/de-emphasis etc. controls
57 static const char *ad1938_deemp[] = {"None", "48kHz", "44.1kHz", "32kHz"};
59 static const struct soc_enum ad1938_deemp_enum =
60 SOC_ENUM_SINGLE(AD1938_DAC_CTRL2, 1, 4, ad1938_deemp);
62 static const struct snd_kcontrol_new ad1938_snd_controls[] = {
63 /* DAC volume control */
64 SOC_DOUBLE_R("DAC1 Volume", AD1938_DAC_L1_VOL,
65 AD1938_DAC_R1_VOL, 0, 0xFF, 1),
66 SOC_DOUBLE_R("DAC2 Volume", AD1938_DAC_L2_VOL,
67 AD1938_DAC_R2_VOL, 0, 0xFF, 1),
68 SOC_DOUBLE_R("DAC3 Volume", AD1938_DAC_L3_VOL,
69 AD1938_DAC_R3_VOL, 0, 0xFF, 1),
70 SOC_DOUBLE_R("DAC4 Volume", AD1938_DAC_L4_VOL,
71 AD1938_DAC_R4_VOL, 0, 0xFF, 1),
73 /* ADC switch control */
74 SOC_DOUBLE("ADC1 Switch", AD1938_ADC_CTRL0, AD1938_ADCL1_MUTE,
75 AD1938_ADCR1_MUTE, 1, 1),
76 SOC_DOUBLE("ADC2 Switch", AD1938_ADC_CTRL0, AD1938_ADCL2_MUTE,
77 AD1938_ADCR2_MUTE, 1, 1),
79 /* DAC switch control */
80 SOC_DOUBLE("DAC1 Switch", AD1938_DAC_CHNL_MUTE, AD1938_DACL1_MUTE,
81 AD1938_DACR1_MUTE, 1, 1),
82 SOC_DOUBLE("DAC2 Switch", AD1938_DAC_CHNL_MUTE, AD1938_DACL2_MUTE,
83 AD1938_DACR2_MUTE, 1, 1),
84 SOC_DOUBLE("DAC3 Switch", AD1938_DAC_CHNL_MUTE, AD1938_DACL3_MUTE,
85 AD1938_DACR3_MUTE, 1, 1),
86 SOC_DOUBLE("DAC4 Switch", AD1938_DAC_CHNL_MUTE, AD1938_DACL4_MUTE,
87 AD1938_DACR4_MUTE, 1, 1),
89 /* ADC high-pass filter */
90 SOC_SINGLE("ADC High Pass Filter Switch", AD1938_ADC_CTRL0,
91 AD1938_ADC_HIGHPASS_FILTER, 1, 0),
94 SOC_ENUM("Playback Deemphasis", ad1938_deemp_enum),
97 static const struct snd_soc_dapm_widget ad1938_dapm_widgets[] = {
98 SND_SOC_DAPM_DAC("DAC", "Playback", AD1938_DAC_CTRL0, 0, 1),
99 SND_SOC_DAPM_ADC("ADC", "Capture", SND_SOC_NOPM, 0, 0),
100 SND_SOC_DAPM_SUPPLY("PLL_PWR", AD1938_PLL_CLK_CTRL0, 0, 1, NULL, 0),
101 SND_SOC_DAPM_SUPPLY("ADC_PWR", AD1938_ADC_CTRL0, 0, 1, NULL, 0),
102 SND_SOC_DAPM_OUTPUT("DAC1OUT"),
103 SND_SOC_DAPM_OUTPUT("DAC2OUT"),
104 SND_SOC_DAPM_OUTPUT("DAC3OUT"),
105 SND_SOC_DAPM_OUTPUT("DAC4OUT"),
106 SND_SOC_DAPM_INPUT("ADC1IN"),
107 SND_SOC_DAPM_INPUT("ADC2IN"),
110 static const struct snd_soc_dapm_route audio_paths[] = {
111 { "DAC", NULL, "PLL_PWR" },
112 { "ADC", NULL, "PLL_PWR" },
113 { "DAC", NULL, "ADC_PWR" },
114 { "ADC", NULL, "ADC_PWR" },
115 { "DAC1OUT", "DAC1 Switch", "DAC" },
116 { "DAC2OUT", "DAC2 Switch", "DAC" },
117 { "DAC3OUT", "DAC3 Switch", "DAC" },
118 { "DAC4OUT", "DAC4 Switch", "DAC" },
119 { "ADC", "ADC1 Switch", "ADC1IN" },
120 { "ADC", "ADC2 Switch", "ADC2IN" },
127 static int ad1938_mute(struct snd_soc_dai *dai, int mute)
129 struct snd_soc_codec *codec = dai->codec;
132 reg = codec->read(codec, AD1938_DAC_CTRL2);
133 reg = (mute > 0) ? reg | AD1938_DAC_MASTER_MUTE : reg &
134 (~AD1938_DAC_MASTER_MUTE);
135 codec->write(codec, AD1938_DAC_CTRL2, reg);
140 static int ad1938_set_tdm_slot(struct snd_soc_dai *dai, unsigned int tx_mask,
141 unsigned int rx_mask, int slots, int width)
143 struct snd_soc_codec *codec = dai->codec;
144 int dac_reg = codec->read(codec, AD1938_DAC_CTRL1);
145 int adc_reg = codec->read(codec, AD1938_ADC_CTRL2);
147 dac_reg &= ~AD1938_DAC_CHAN_MASK;
148 adc_reg &= ~AD1938_ADC_CHAN_MASK;
152 dac_reg |= AD1938_DAC_2_CHANNELS << AD1938_DAC_CHAN_SHFT;
153 adc_reg |= AD1938_ADC_2_CHANNELS << AD1938_ADC_CHAN_SHFT;
156 dac_reg |= AD1938_DAC_4_CHANNELS << AD1938_DAC_CHAN_SHFT;
157 adc_reg |= AD1938_ADC_4_CHANNELS << AD1938_ADC_CHAN_SHFT;
160 dac_reg |= AD1938_DAC_8_CHANNELS << AD1938_DAC_CHAN_SHFT;
161 adc_reg |= AD1938_ADC_8_CHANNELS << AD1938_ADC_CHAN_SHFT;
164 dac_reg |= AD1938_DAC_16_CHANNELS << AD1938_DAC_CHAN_SHFT;
165 adc_reg |= AD1938_ADC_16_CHANNELS << AD1938_ADC_CHAN_SHFT;
171 codec->write(codec, AD1938_DAC_CTRL1, dac_reg);
172 codec->write(codec, AD1938_ADC_CTRL2, adc_reg);
177 static int ad1938_set_dai_fmt(struct snd_soc_dai *codec_dai,
180 struct snd_soc_codec *codec = codec_dai->codec;
181 int adc_reg, dac_reg;
183 adc_reg = codec->read(codec, AD1938_ADC_CTRL2);
184 dac_reg = codec->read(codec, AD1938_DAC_CTRL1);
186 /* At present, the driver only support AUX ADC mode(SND_SOC_DAIFMT_I2S
187 * with TDM) and ADC&DAC TDM mode(SND_SOC_DAIFMT_DSP_A)
189 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
190 case SND_SOC_DAIFMT_I2S:
191 adc_reg &= ~AD1938_ADC_SERFMT_MASK;
192 adc_reg |= AD1938_ADC_SERFMT_TDM;
194 case SND_SOC_DAIFMT_DSP_A:
195 adc_reg &= ~AD1938_ADC_SERFMT_MASK;
196 adc_reg |= AD1938_ADC_SERFMT_AUX;
202 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
203 case SND_SOC_DAIFMT_NB_NF: /* normal bit clock + frame */
204 adc_reg &= ~AD1938_ADC_LEFT_HIGH;
205 adc_reg &= ~AD1938_ADC_BCLK_INV;
206 dac_reg &= ~AD1938_DAC_LEFT_HIGH;
207 dac_reg &= ~AD1938_DAC_BCLK_INV;
209 case SND_SOC_DAIFMT_NB_IF: /* normal bclk + invert frm */
210 adc_reg |= AD1938_ADC_LEFT_HIGH;
211 adc_reg &= ~AD1938_ADC_BCLK_INV;
212 dac_reg |= AD1938_DAC_LEFT_HIGH;
213 dac_reg &= ~AD1938_DAC_BCLK_INV;
215 case SND_SOC_DAIFMT_IB_NF: /* invert bclk + normal frm */
216 adc_reg &= ~AD1938_ADC_LEFT_HIGH;
217 adc_reg |= AD1938_ADC_BCLK_INV;
218 dac_reg &= ~AD1938_DAC_LEFT_HIGH;
219 dac_reg |= AD1938_DAC_BCLK_INV;
222 case SND_SOC_DAIFMT_IB_IF: /* invert bclk + frm */
223 adc_reg |= AD1938_ADC_LEFT_HIGH;
224 adc_reg |= AD1938_ADC_BCLK_INV;
225 dac_reg |= AD1938_DAC_LEFT_HIGH;
226 dac_reg |= AD1938_DAC_BCLK_INV;
232 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
233 case SND_SOC_DAIFMT_CBM_CFM: /* codec clk & frm master */
234 adc_reg |= AD1938_ADC_LCR_MASTER;
235 adc_reg |= AD1938_ADC_BCLK_MASTER;
236 dac_reg |= AD1938_DAC_LCR_MASTER;
237 dac_reg |= AD1938_DAC_BCLK_MASTER;
239 case SND_SOC_DAIFMT_CBS_CFM: /* codec clk slave & frm master */
240 adc_reg |= AD1938_ADC_LCR_MASTER;
241 adc_reg &= ~AD1938_ADC_BCLK_MASTER;
242 dac_reg |= AD1938_DAC_LCR_MASTER;
243 dac_reg &= ~AD1938_DAC_BCLK_MASTER;
245 case SND_SOC_DAIFMT_CBM_CFS: /* codec clk master & frame slave */
246 adc_reg &= ~AD1938_ADC_LCR_MASTER;
247 adc_reg |= AD1938_ADC_BCLK_MASTER;
248 dac_reg &= ~AD1938_DAC_LCR_MASTER;
249 dac_reg |= AD1938_DAC_BCLK_MASTER;
251 case SND_SOC_DAIFMT_CBS_CFS: /* codec clk & frm slave */
252 adc_reg &= ~AD1938_ADC_LCR_MASTER;
253 adc_reg &= ~AD1938_ADC_BCLK_MASTER;
254 dac_reg &= ~AD1938_DAC_LCR_MASTER;
255 dac_reg &= ~AD1938_DAC_BCLK_MASTER;
261 codec->write(codec, AD1938_ADC_CTRL2, adc_reg);
262 codec->write(codec, AD1938_DAC_CTRL1, dac_reg);
267 static int ad1938_hw_params(struct snd_pcm_substream *substream,
268 struct snd_pcm_hw_params *params,
269 struct snd_soc_dai *dai)
271 int word_len = 0, reg = 0;
273 struct snd_soc_pcm_runtime *rtd = substream->private_data;
274 struct snd_soc_device *socdev = rtd->socdev;
275 struct snd_soc_codec *codec = socdev->card->codec;
278 switch (params_format(params)) {
279 case SNDRV_PCM_FORMAT_S16_LE:
282 case SNDRV_PCM_FORMAT_S20_3LE:
285 case SNDRV_PCM_FORMAT_S24_LE:
286 case SNDRV_PCM_FORMAT_S32_LE:
291 reg = codec->read(codec, AD1938_DAC_CTRL2);
292 reg = (reg & (~AD1938_DAC_WORD_LEN_MASK)) | word_len;
293 codec->write(codec, AD1938_DAC_CTRL2, reg);
295 reg = codec->read(codec, AD1938_ADC_CTRL1);
296 reg = (reg & (~AD1938_ADC_WORD_LEN_MASK)) | word_len;
297 codec->write(codec, AD1938_ADC_CTRL1, reg);
303 * interface to read/write ad1938 register
306 #define AD1938_SPI_ADDR 0x4
307 #define AD1938_SPI_READ 0x1
308 #define AD1938_SPI_BUFLEN 3
311 * write to the ad1938 register space
314 static int ad1938_write_reg(struct snd_soc_codec *codec, unsigned int reg,
317 u8 *reg_cache = codec->reg_cache;
320 if (value != reg_cache[reg]) {
321 uint8_t buf[AD1938_SPI_BUFLEN];
322 struct spi_transfer t = {
324 .len = AD1938_SPI_BUFLEN,
326 struct spi_message m;
328 buf[0] = AD1938_SPI_ADDR << 1;
331 spi_message_init(&m);
332 spi_message_add_tail(&t, &m);
333 ret = spi_sync(codec->control_data, &m);
335 reg_cache[reg] = value;
342 * read from the ad1938 register space cache
345 static unsigned int ad1938_read_reg_cache(struct snd_soc_codec *codec,
348 u8 *reg_cache = codec->reg_cache;
350 if (reg >= codec->reg_cache_size)
353 return reg_cache[reg];
357 * read from the ad1938 register space
360 static unsigned int ad1938_read_reg(struct snd_soc_codec *codec,
363 char w_buf[AD1938_SPI_BUFLEN];
364 char r_buf[AD1938_SPI_BUFLEN];
367 struct spi_transfer t = {
370 .len = AD1938_SPI_BUFLEN,
372 struct spi_message m;
374 w_buf[0] = (AD1938_SPI_ADDR << 1) | AD1938_SPI_READ;
378 spi_message_init(&m);
379 spi_message_add_tail(&t, &m);
380 ret = spi_sync(codec->control_data, &m);
387 static int ad1938_fill_cache(struct snd_soc_codec *codec)
390 u8 *reg_cache = codec->reg_cache;
391 struct spi_device *spi = codec->control_data;
393 for (i = 0; i < codec->reg_cache_size; i++) {
394 int ret = ad1938_read_reg(codec, i);
396 dev_err(&spi->dev, "AD1938 SPI read failure\n");
405 static int __devinit ad1938_spi_probe(struct spi_device *spi)
407 struct snd_soc_codec *codec;
408 struct ad1938_priv *ad1938;
410 ad1938 = kzalloc(sizeof(struct ad1938_priv), GFP_KERNEL);
414 codec = &ad1938->codec;
415 codec->control_data = spi;
416 codec->dev = &spi->dev;
418 dev_set_drvdata(&spi->dev, ad1938);
420 return ad1938_register(ad1938);
423 static int __devexit ad1938_spi_remove(struct spi_device *spi)
425 struct ad1938_priv *ad1938 = dev_get_drvdata(&spi->dev);
427 ad1938_unregister(ad1938);
431 static struct spi_driver ad1938_spi_driver = {
434 .owner = THIS_MODULE,
436 .probe = ad1938_spi_probe,
437 .remove = __devexit_p(ad1938_spi_remove),
440 static struct snd_soc_dai_ops ad1938_dai_ops = {
441 .hw_params = ad1938_hw_params,
442 .digital_mute = ad1938_mute,
443 .set_tdm_slot = ad1938_set_tdm_slot,
444 .set_fmt = ad1938_set_dai_fmt,
447 /* codec DAI instance */
448 struct snd_soc_dai ad1938_dai = {
451 .stream_name = "Playback",
454 .rates = SNDRV_PCM_RATE_48000,
455 .formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
456 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
459 .stream_name = "Capture",
462 .rates = SNDRV_PCM_RATE_48000,
463 .formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
464 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
466 .ops = &ad1938_dai_ops,
468 EXPORT_SYMBOL_GPL(ad1938_dai);
470 static int ad1938_register(struct ad1938_priv *ad1938)
473 struct snd_soc_codec *codec = &ad1938->codec;
476 dev_err(codec->dev, "Another ad1938 is registered\n");
480 mutex_init(&codec->mutex);
481 INIT_LIST_HEAD(&codec->dapm_widgets);
482 INIT_LIST_HEAD(&codec->dapm_paths);
483 codec->private_data = ad1938;
484 codec->reg_cache = ad1938->reg_cache;
485 codec->reg_cache_size = AD1938_NUM_REGS;
486 codec->name = "AD1938";
487 codec->owner = THIS_MODULE;
488 codec->dai = &ad1938_dai;
490 codec->write = ad1938_write_reg;
491 codec->read = ad1938_read_reg_cache;
492 INIT_LIST_HEAD(&codec->dapm_widgets);
493 INIT_LIST_HEAD(&codec->dapm_paths);
495 ad1938_dai.dev = codec->dev;
496 ad1938_codec = codec;
498 /* default setting for ad1938 */
500 /* unmute dac channels */
501 codec->write(codec, AD1938_DAC_CHNL_MUTE, 0x0);
502 /* de-emphasis: 48kHz, powedown dac */
503 codec->write(codec, AD1938_DAC_CTRL2, 0x1A);
504 /* powerdown dac, dac in tdm mode */
505 codec->write(codec, AD1938_DAC_CTRL0, 0x41);
506 /* high-pass filter enable */
507 codec->write(codec, AD1938_ADC_CTRL0, 0x3);
508 /* sata delay=1, adc aux mode */
509 codec->write(codec, AD1938_ADC_CTRL1, 0x43);
510 /* pll input: mclki/xi */
511 codec->write(codec, AD1938_PLL_CLK_CTRL0, 0x9D);
512 codec->write(codec, AD1938_PLL_CLK_CTRL1, 0x04);
514 ad1938_fill_cache(codec);
516 ret = snd_soc_register_codec(codec);
518 dev_err(codec->dev, "Failed to register codec: %d\n", ret);
523 ret = snd_soc_register_dai(&ad1938_dai);
525 dev_err(codec->dev, "Failed to register DAI: %d\n", ret);
526 snd_soc_unregister_codec(codec);
534 static void ad1938_unregister(struct ad1938_priv *ad1938)
536 snd_soc_unregister_dai(&ad1938_dai);
537 snd_soc_unregister_codec(&ad1938->codec);
542 static int ad1938_probe(struct platform_device *pdev)
544 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
545 struct snd_soc_codec *codec;
548 if (ad1938_codec == NULL) {
549 dev_err(&pdev->dev, "Codec device not registered\n");
553 socdev->card->codec = ad1938_codec;
554 codec = ad1938_codec;
557 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
559 dev_err(codec->dev, "failed to create pcms: %d\n", ret);
563 snd_soc_add_controls(codec, ad1938_snd_controls,
564 ARRAY_SIZE(ad1938_snd_controls));
565 snd_soc_dapm_new_controls(codec, ad1938_dapm_widgets,
566 ARRAY_SIZE(ad1938_dapm_widgets));
567 snd_soc_dapm_add_routes(codec, audio_paths, ARRAY_SIZE(audio_paths));
574 /* power down chip */
575 static int ad1938_remove(struct platform_device *pdev)
577 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
579 snd_soc_free_pcms(socdev);
580 snd_soc_dapm_free(socdev);
585 struct snd_soc_codec_device soc_codec_dev_ad1938 = {
586 .probe = ad1938_probe,
587 .remove = ad1938_remove,
589 EXPORT_SYMBOL_GPL(soc_codec_dev_ad1938);
591 static int __init ad1938_init(void)
595 ret = spi_register_driver(&ad1938_spi_driver);
597 printk(KERN_ERR "Failed to register ad1938 SPI driver: %d\n",
603 module_init(ad1938_init);
605 static void __exit ad1938_exit(void)
607 spi_unregister_driver(&ad1938_spi_driver);
609 module_exit(ad1938_exit);
611 MODULE_DESCRIPTION("ASoC ad1938 driver");
612 MODULE_AUTHOR("Barry Song ");
613 MODULE_LICENSE("GPL");