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
];
50 static struct snd_soc_codec
*ad1938_codec
;
51 struct snd_soc_codec_device soc_codec_dev_ad1938
;
52 static int ad1938_register(struct ad1938_priv
*ad1938
);
53 static void ad1938_unregister(struct ad1938_priv
*ad1938
);
56 * AD1938 volume/mute/de-emphasis etc. controls
58 static const char *ad1938_deemp
[] = {"None", "48kHz", "44.1kHz", "32kHz"};
60 static const struct soc_enum ad1938_deemp_enum
=
61 SOC_ENUM_SINGLE(AD1938_DAC_CTRL2
, 1, 4, ad1938_deemp
);
63 static const struct snd_kcontrol_new ad1938_snd_controls
[] = {
64 /* DAC volume control */
65 SOC_DOUBLE_R("DAC1 Volume", AD1938_DAC_L1_VOL
,
66 AD1938_DAC_R1_VOL
, 0, 0xFF, 1),
67 SOC_DOUBLE_R("DAC2 Volume", AD1938_DAC_L2_VOL
,
68 AD1938_DAC_R2_VOL
, 0, 0xFF, 1),
69 SOC_DOUBLE_R("DAC3 Volume", AD1938_DAC_L3_VOL
,
70 AD1938_DAC_R3_VOL
, 0, 0xFF, 1),
71 SOC_DOUBLE_R("DAC4 Volume", AD1938_DAC_L4_VOL
,
72 AD1938_DAC_R4_VOL
, 0, 0xFF, 1),
74 /* ADC switch control */
75 SOC_DOUBLE("ADC1 Switch", AD1938_ADC_CTRL0
, AD1938_ADCL1_MUTE
,
76 AD1938_ADCR1_MUTE
, 1, 1),
77 SOC_DOUBLE("ADC2 Switch", AD1938_ADC_CTRL0
, AD1938_ADCL2_MUTE
,
78 AD1938_ADCR2_MUTE
, 1, 1),
80 /* DAC switch control */
81 SOC_DOUBLE("DAC1 Switch", AD1938_DAC_CHNL_MUTE
, AD1938_DACL1_MUTE
,
82 AD1938_DACR1_MUTE
, 1, 1),
83 SOC_DOUBLE("DAC2 Switch", AD1938_DAC_CHNL_MUTE
, AD1938_DACL2_MUTE
,
84 AD1938_DACR2_MUTE
, 1, 1),
85 SOC_DOUBLE("DAC3 Switch", AD1938_DAC_CHNL_MUTE
, AD1938_DACL3_MUTE
,
86 AD1938_DACR3_MUTE
, 1, 1),
87 SOC_DOUBLE("DAC4 Switch", AD1938_DAC_CHNL_MUTE
, AD1938_DACL4_MUTE
,
88 AD1938_DACR4_MUTE
, 1, 1),
90 /* ADC high-pass filter */
91 SOC_SINGLE("ADC High Pass Filter Switch", AD1938_ADC_CTRL0
,
92 AD1938_ADC_HIGHPASS_FILTER
, 1, 0),
95 SOC_ENUM("Playback Deemphasis", ad1938_deemp_enum
),
98 static const struct snd_soc_dapm_widget ad1938_dapm_widgets
[] = {
99 SND_SOC_DAPM_DAC("DAC", "Playback", AD1938_DAC_CTRL0
, 0, 1),
100 SND_SOC_DAPM_ADC("ADC", "Capture", SND_SOC_NOPM
, 0, 0),
101 SND_SOC_DAPM_SUPPLY("ADC_PWR", AD1938_ADC_CTRL0
, 0, 1, NULL
, 0),
104 static const struct snd_soc_dapm_route audio_paths
[] = {
105 { "DAC", NULL
, "ADC_PWR" },
106 { "ADC", NULL
, "ADC_PWR" },
113 static int ad1938_mute(struct snd_soc_dai
*dai
, int mute
)
115 struct snd_soc_codec
*codec
= dai
->codec
;
118 reg
= codec
->read(codec
, AD1938_DAC_CTRL2
);
119 reg
= (mute
> 0) ? reg
| AD1938_DAC_MASTER_MUTE
: reg
&
120 (~AD1938_DAC_MASTER_MUTE
);
121 codec
->write(codec
, AD1938_DAC_CTRL2
, reg
);
126 static inline int ad1938_pll_powerctrl(struct snd_soc_codec
*codec
, int cmd
)
128 int reg
= codec
->read(codec
, AD1938_PLL_CLK_CTRL0
);
129 reg
= (cmd
> 0) ? reg
& (~AD1938_PLL_POWERDOWN
) : reg
|
130 AD1938_PLL_POWERDOWN
;
131 codec
->write(codec
, AD1938_PLL_CLK_CTRL0
, reg
);
136 static int ad1938_set_tdm_slot(struct snd_soc_dai
*dai
,
137 unsigned int mask
, int slots
)
139 struct snd_soc_codec
*codec
= dai
->codec
;
140 int dac_reg
= codec
->read(codec
, AD1938_DAC_CTRL1
);
141 int adc_reg
= codec
->read(codec
, AD1938_ADC_CTRL2
);
143 dac_reg
&= ~AD1938_DAC_CHAN_MASK
;
144 adc_reg
&= ~AD1938_ADC_CHAN_MASK
;
148 dac_reg
|= AD1938_DAC_2_CHANNELS
<< AD1938_DAC_CHAN_SHFT
;
149 adc_reg
|= AD1938_ADC_2_CHANNELS
<< AD1938_ADC_CHAN_SHFT
;
152 dac_reg
|= AD1938_DAC_4_CHANNELS
<< AD1938_DAC_CHAN_SHFT
;
153 adc_reg
|= AD1938_ADC_4_CHANNELS
<< AD1938_ADC_CHAN_SHFT
;
156 dac_reg
|= AD1938_DAC_8_CHANNELS
<< AD1938_DAC_CHAN_SHFT
;
157 adc_reg
|= AD1938_ADC_8_CHANNELS
<< AD1938_ADC_CHAN_SHFT
;
160 dac_reg
|= AD1938_DAC_16_CHANNELS
<< AD1938_DAC_CHAN_SHFT
;
161 adc_reg
|= AD1938_ADC_16_CHANNELS
<< AD1938_ADC_CHAN_SHFT
;
167 codec
->write(codec
, AD1938_DAC_CTRL1
, dac_reg
);
168 codec
->write(codec
, AD1938_ADC_CTRL2
, adc_reg
);
173 static int ad1938_set_dai_fmt(struct snd_soc_dai
*codec_dai
,
176 struct snd_soc_codec
*codec
= codec_dai
->codec
;
177 int adc_reg
, dac_reg
;
179 adc_reg
= codec
->read(codec
, AD1938_ADC_CTRL2
);
180 dac_reg
= codec
->read(codec
, AD1938_DAC_CTRL1
);
182 /* At present, the driver only support AUX ADC mode(SND_SOC_DAIFMT_I2S
183 * with TDM) and ADC&DAC TDM mode(SND_SOC_DAIFMT_DSP_A)
185 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
186 case SND_SOC_DAIFMT_I2S
:
187 adc_reg
&= ~AD1938_ADC_SERFMT_MASK
;
188 adc_reg
|= AD1938_ADC_SERFMT_TDM
;
190 case SND_SOC_DAIFMT_DSP_A
:
191 adc_reg
&= ~AD1938_ADC_SERFMT_MASK
;
192 adc_reg
|= AD1938_ADC_SERFMT_AUX
;
198 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
199 case SND_SOC_DAIFMT_NB_NF
: /* normal bit clock + frame */
200 adc_reg
&= ~AD1938_ADC_LEFT_HIGH
;
201 adc_reg
&= ~AD1938_ADC_BCLK_INV
;
202 dac_reg
&= ~AD1938_DAC_LEFT_HIGH
;
203 dac_reg
&= ~AD1938_DAC_BCLK_INV
;
205 case SND_SOC_DAIFMT_NB_IF
: /* normal bclk + invert frm */
206 adc_reg
|= AD1938_ADC_LEFT_HIGH
;
207 adc_reg
&= ~AD1938_ADC_BCLK_INV
;
208 dac_reg
|= AD1938_DAC_LEFT_HIGH
;
209 dac_reg
&= ~AD1938_DAC_BCLK_INV
;
211 case SND_SOC_DAIFMT_IB_NF
: /* invert bclk + normal 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
;
218 case SND_SOC_DAIFMT_IB_IF
: /* invert bclk + frm */
219 adc_reg
|= AD1938_ADC_LEFT_HIGH
;
220 adc_reg
|= AD1938_ADC_BCLK_INV
;
221 dac_reg
|= AD1938_DAC_LEFT_HIGH
;
222 dac_reg
|= AD1938_DAC_BCLK_INV
;
228 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
229 case SND_SOC_DAIFMT_CBM_CFM
: /* codec clk & frm master */
230 adc_reg
|= AD1938_ADC_LCR_MASTER
;
231 adc_reg
|= AD1938_ADC_BCLK_MASTER
;
232 dac_reg
|= AD1938_DAC_LCR_MASTER
;
233 dac_reg
|= AD1938_DAC_BCLK_MASTER
;
235 case SND_SOC_DAIFMT_CBS_CFM
: /* codec clk slave & frm master */
236 adc_reg
|= AD1938_ADC_LCR_MASTER
;
237 adc_reg
&= ~AD1938_ADC_BCLK_MASTER
;
238 dac_reg
|= AD1938_DAC_LCR_MASTER
;
239 dac_reg
&= ~AD1938_DAC_BCLK_MASTER
;
241 case SND_SOC_DAIFMT_CBM_CFS
: /* codec clk master & frame slave */
242 adc_reg
&= ~AD1938_ADC_LCR_MASTER
;
243 adc_reg
|= AD1938_ADC_BCLK_MASTER
;
244 dac_reg
&= ~AD1938_DAC_LCR_MASTER
;
245 dac_reg
|= AD1938_DAC_BCLK_MASTER
;
247 case SND_SOC_DAIFMT_CBS_CFS
: /* codec clk & frm slave */
248 adc_reg
&= ~AD1938_ADC_LCR_MASTER
;
249 adc_reg
&= ~AD1938_ADC_BCLK_MASTER
;
250 dac_reg
&= ~AD1938_DAC_LCR_MASTER
;
251 dac_reg
&= ~AD1938_DAC_BCLK_MASTER
;
257 codec
->write(codec
, AD1938_ADC_CTRL2
, adc_reg
);
258 codec
->write(codec
, AD1938_DAC_CTRL1
, dac_reg
);
263 static int ad1938_hw_params(struct snd_pcm_substream
*substream
,
264 struct snd_pcm_hw_params
*params
,
265 struct snd_soc_dai
*dai
)
267 int word_len
= 0, reg
= 0;
269 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
270 struct snd_soc_device
*socdev
= rtd
->socdev
;
271 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
274 switch (params_format(params
)) {
275 case SNDRV_PCM_FORMAT_S16_LE
:
278 case SNDRV_PCM_FORMAT_S20_3LE
:
281 case SNDRV_PCM_FORMAT_S24_LE
:
282 case SNDRV_PCM_FORMAT_S32_LE
:
287 reg
= codec
->read(codec
, AD1938_DAC_CTRL2
);
288 reg
= (reg
& (~AD1938_DAC_WORD_LEN_MASK
)) | word_len
;
289 codec
->write(codec
, AD1938_DAC_CTRL2
, reg
);
291 reg
= codec
->read(codec
, AD1938_ADC_CTRL1
);
292 reg
= (reg
& (~AD1938_ADC_WORD_LEN_MASK
)) | word_len
;
293 codec
->write(codec
, AD1938_ADC_CTRL1
, reg
);
298 static int ad1938_set_bias_level(struct snd_soc_codec
*codec
,
299 enum snd_soc_bias_level level
)
302 case SND_SOC_BIAS_ON
:
303 ad1938_pll_powerctrl(codec
, 1);
305 case SND_SOC_BIAS_PREPARE
:
307 case SND_SOC_BIAS_STANDBY
:
308 case SND_SOC_BIAS_OFF
:
309 ad1938_pll_powerctrl(codec
, 0);
312 codec
->bias_level
= level
;
317 * interface to read/write ad1938 register
320 #define AD1938_SPI_ADDR 0x4
321 #define AD1938_SPI_READ 0x1
322 #define AD1938_SPI_BUFLEN 3
325 * write to the ad1938 register space
328 static int ad1938_write_reg(struct snd_soc_codec
*codec
, unsigned int reg
,
331 u8
*reg_cache
= codec
->reg_cache
;
334 if (value
!= reg_cache
[reg
]) {
335 uint8_t buf
[AD1938_SPI_BUFLEN
];
336 struct spi_transfer t
= {
338 .len
= AD1938_SPI_BUFLEN
,
340 struct spi_message m
;
342 buf
[0] = AD1938_SPI_ADDR
<< 1;
345 spi_message_init(&m
);
346 spi_message_add_tail(&t
, &m
);
347 ret
= spi_sync(codec
->control_data
, &m
);
349 reg_cache
[reg
] = value
;
356 * read from the ad1938 register space cache
359 static unsigned int ad1938_read_reg_cache(struct snd_soc_codec
*codec
,
362 u8
*reg_cache
= codec
->reg_cache
;
364 if (reg
>= codec
->reg_cache_size
)
367 return reg_cache
[reg
];
371 * read from the ad1938 register space
374 static unsigned int ad1938_read_reg(struct snd_soc_codec
*codec
,
377 char w_buf
[AD1938_SPI_BUFLEN
];
378 char r_buf
[AD1938_SPI_BUFLEN
];
381 struct spi_transfer t
= {
384 .len
= AD1938_SPI_BUFLEN
,
386 struct spi_message m
;
388 w_buf
[0] = (AD1938_SPI_ADDR
<< 1) | AD1938_SPI_READ
;
392 spi_message_init(&m
);
393 spi_message_add_tail(&t
, &m
);
394 ret
= spi_sync(codec
->control_data
, &m
);
401 static int ad1938_fill_cache(struct snd_soc_codec
*codec
)
404 u8
*reg_cache
= codec
->reg_cache
;
405 struct spi_device
*spi
= codec
->control_data
;
407 for (i
= 0; i
< codec
->reg_cache_size
; i
++) {
408 int ret
= ad1938_read_reg(codec
, i
);
410 dev_err(&spi
->dev
, "AD1938 SPI read failure\n");
419 static int __devinit
ad1938_spi_probe(struct spi_device
*spi
)
421 struct snd_soc_codec
*codec
;
422 struct ad1938_priv
*ad1938
;
424 ad1938
= kzalloc(sizeof(struct ad1938_priv
), GFP_KERNEL
);
428 codec
= &ad1938
->codec
;
429 codec
->control_data
= spi
;
430 codec
->dev
= &spi
->dev
;
432 dev_set_drvdata(&spi
->dev
, ad1938
);
434 return ad1938_register(ad1938
);
437 static int __devexit
ad1938_spi_remove(struct spi_device
*spi
)
439 struct ad1938_priv
*ad1938
= dev_get_drvdata(&spi
->dev
);
441 ad1938_unregister(ad1938
);
445 static struct spi_driver ad1938_spi_driver
= {
447 .name
= "ad1938-spi",
448 .bus
= &spi_bus_type
,
449 .owner
= THIS_MODULE
,
451 .probe
= ad1938_spi_probe
,
452 .remove
= __devexit_p(ad1938_spi_remove
),
455 static struct snd_soc_dai_ops ad1938_dai_ops
= {
456 .hw_params
= ad1938_hw_params
,
457 .digital_mute
= ad1938_mute
,
458 .set_tdm_slot
= ad1938_set_tdm_slot
,
459 .set_fmt
= ad1938_set_dai_fmt
,
462 /* codec DAI instance */
463 struct snd_soc_dai ad1938_dai
= {
466 .stream_name
= "Playback",
469 .rates
= SNDRV_PCM_RATE_48000
,
470 .formats
= SNDRV_PCM_FMTBIT_S32_LE
| SNDRV_PCM_FMTBIT_S16_LE
|
471 SNDRV_PCM_FMTBIT_S20_3LE
| SNDRV_PCM_FMTBIT_S24_LE
,
474 .stream_name
= "Capture",
477 .rates
= SNDRV_PCM_RATE_48000
,
478 .formats
= SNDRV_PCM_FMTBIT_S32_LE
| SNDRV_PCM_FMTBIT_S16_LE
|
479 SNDRV_PCM_FMTBIT_S20_3LE
| SNDRV_PCM_FMTBIT_S24_LE
,
481 .ops
= &ad1938_dai_ops
,
483 EXPORT_SYMBOL_GPL(ad1938_dai
);
485 static int ad1938_register(struct ad1938_priv
*ad1938
)
488 struct snd_soc_codec
*codec
= &ad1938
->codec
;
491 dev_err(codec
->dev
, "Another ad1938 is registered\n");
495 mutex_init(&codec
->mutex
);
496 INIT_LIST_HEAD(&codec
->dapm_widgets
);
497 INIT_LIST_HEAD(&codec
->dapm_paths
);
498 codec
->private_data
= ad1938
;
499 codec
->reg_cache
= ad1938
->reg_cache
;
500 codec
->reg_cache_size
= AD1938_NUM_REGS
;
501 codec
->name
= "AD1938";
502 codec
->owner
= THIS_MODULE
;
503 codec
->dai
= &ad1938_dai
;
505 codec
->write
= ad1938_write_reg
;
506 codec
->read
= ad1938_read_reg_cache
;
507 INIT_LIST_HEAD(&codec
->dapm_widgets
);
508 INIT_LIST_HEAD(&codec
->dapm_paths
);
510 ad1938_dai
.dev
= codec
->dev
;
511 ad1938_codec
= codec
;
513 /* default setting for ad1938 */
515 /* unmute dac channels */
516 codec
->write(codec
, AD1938_DAC_CHNL_MUTE
, 0x0);
517 /* de-emphasis: 48kHz, powedown dac */
518 codec
->write(codec
, AD1938_DAC_CTRL2
, 0x1A);
519 /* powerdown dac, dac in tdm mode */
520 codec
->write(codec
, AD1938_DAC_CTRL0
, 0x41);
521 /* high-pass filter enable */
522 codec
->write(codec
, AD1938_ADC_CTRL0
, 0x3);
523 /* sata delay=1, adc aux mode */
524 codec
->write(codec
, AD1938_ADC_CTRL1
, 0x43);
525 /* pll input: mclki/xi */
526 codec
->write(codec
, AD1938_PLL_CLK_CTRL0
, 0x9D);
527 codec
->write(codec
, AD1938_PLL_CLK_CTRL1
, 0x04);
529 ad1938_fill_cache(codec
);
531 ret
= snd_soc_register_codec(codec
);
533 dev_err(codec
->dev
, "Failed to register codec: %d\n", ret
);
537 ret
= snd_soc_register_dai(&ad1938_dai
);
539 dev_err(codec
->dev
, "Failed to register DAI: %d\n", ret
);
540 snd_soc_unregister_codec(codec
);
547 static void ad1938_unregister(struct ad1938_priv
*ad1938
)
549 ad1938_set_bias_level(&ad1938
->codec
, SND_SOC_BIAS_OFF
);
550 snd_soc_unregister_dai(&ad1938_dai
);
551 snd_soc_unregister_codec(&ad1938
->codec
);
556 static int ad1938_probe(struct platform_device
*pdev
)
558 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
559 struct snd_soc_codec
*codec
;
562 if (ad1938_codec
== NULL
) {
563 dev_err(&pdev
->dev
, "Codec device not registered\n");
567 socdev
->card
->codec
= ad1938_codec
;
568 codec
= ad1938_codec
;
571 ret
= snd_soc_new_pcms(socdev
, SNDRV_DEFAULT_IDX1
, SNDRV_DEFAULT_STR1
);
573 dev_err(codec
->dev
, "failed to create pcms: %d\n", ret
);
577 snd_soc_add_controls(codec
, ad1938_snd_controls
,
578 ARRAY_SIZE(ad1938_snd_controls
));
579 snd_soc_dapm_new_controls(codec
, ad1938_dapm_widgets
,
580 ARRAY_SIZE(ad1938_dapm_widgets
));
581 snd_soc_dapm_add_routes(codec
, audio_paths
, ARRAY_SIZE(audio_paths
));
582 snd_soc_dapm_new_widgets(codec
);
584 ad1938_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
586 ret
= snd_soc_init_card(socdev
);
588 dev_err(codec
->dev
, "failed to register card: %d\n", ret
);
595 snd_soc_free_pcms(socdev
);
596 snd_soc_dapm_free(socdev
);
601 /* power down chip */
602 static int ad1938_remove(struct platform_device
*pdev
)
604 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
606 snd_soc_free_pcms(socdev
);
607 snd_soc_dapm_free(socdev
);
613 static int ad1938_suspend(struct platform_device
*pdev
,
616 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
617 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
619 ad1938_set_bias_level(codec
, SND_SOC_BIAS_OFF
);
623 static int ad1938_resume(struct platform_device
*pdev
)
625 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
626 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
628 if (codec
->suspend_bias_level
== SND_SOC_BIAS_ON
)
629 ad1938_set_bias_level(codec
, SND_SOC_BIAS_ON
);
634 #define ad1938_suspend NULL
635 #define ad1938_resume NULL
638 struct snd_soc_codec_device soc_codec_dev_ad1938
= {
639 .probe
= ad1938_probe
,
640 .remove
= ad1938_remove
,
641 .suspend
= ad1938_suspend
,
642 .resume
= ad1938_resume
,
644 EXPORT_SYMBOL_GPL(soc_codec_dev_ad1938
);
646 static int __init
ad1938_init(void)
650 ret
= spi_register_driver(&ad1938_spi_driver
);
652 printk(KERN_ERR
"Failed to register ad1938 SPI driver: %d\n",
658 module_init(ad1938_init
);
660 static void __exit
ad1938_exit(void)
662 spi_unregister_driver(&ad1938_spi_driver
);
664 module_exit(ad1938_exit
);
666 MODULE_DESCRIPTION("ASoC ad1938 driver");
667 MODULE_AUTHOR("Barry Song ");
668 MODULE_LICENSE("GPL");