2 * Driver for ADAU1701 SigmaDSP processor
4 * Copyright 2011 Analog Devices Inc.
5 * Author: Lars-Peter Clausen <lars@metafoo.de>
6 * based on an inital version by Cliff Cai <cliff.cai@analog.com>
8 * Licensed under the GPL-2 or later.
11 #include <linux/module.h>
12 #include <linux/init.h>
13 #include <linux/i2c.h>
14 #include <linux/delay.h>
15 #include <linux/slab.h>
17 #include <linux/of_gpio.h>
18 #include <linux/of_device.h>
19 #include <sound/core.h>
20 #include <sound/pcm.h>
21 #include <sound/pcm_params.h>
22 #include <sound/soc.h>
27 #define ADAU1701_DSPCTRL 0x1c
28 #define ADAU1701_SEROCTL 0x1e
29 #define ADAU1701_SERICTL 0x1f
31 #define ADAU1701_AUXNPOW 0x22
33 #define ADAU1701_OSCIPOW 0x26
34 #define ADAU1701_DACSET 0x27
36 #define ADAU1701_NUM_REGS 0x28
38 #define ADAU1701_DSPCTRL_CR (1 << 2)
39 #define ADAU1701_DSPCTRL_DAM (1 << 3)
40 #define ADAU1701_DSPCTRL_ADM (1 << 4)
41 #define ADAU1701_DSPCTRL_SR_48 0x00
42 #define ADAU1701_DSPCTRL_SR_96 0x01
43 #define ADAU1701_DSPCTRL_SR_192 0x02
44 #define ADAU1701_DSPCTRL_SR_MASK 0x03
46 #define ADAU1701_SEROCTL_INV_LRCLK 0x2000
47 #define ADAU1701_SEROCTL_INV_BCLK 0x1000
48 #define ADAU1701_SEROCTL_MASTER 0x0800
50 #define ADAU1701_SEROCTL_OBF16 0x0000
51 #define ADAU1701_SEROCTL_OBF8 0x0200
52 #define ADAU1701_SEROCTL_OBF4 0x0400
53 #define ADAU1701_SEROCTL_OBF2 0x0600
54 #define ADAU1701_SEROCTL_OBF_MASK 0x0600
56 #define ADAU1701_SEROCTL_OLF1024 0x0000
57 #define ADAU1701_SEROCTL_OLF512 0x0080
58 #define ADAU1701_SEROCTL_OLF256 0x0100
59 #define ADAU1701_SEROCTL_OLF_MASK 0x0180
61 #define ADAU1701_SEROCTL_MSB_DEALY1 0x0000
62 #define ADAU1701_SEROCTL_MSB_DEALY0 0x0004
63 #define ADAU1701_SEROCTL_MSB_DEALY8 0x0008
64 #define ADAU1701_SEROCTL_MSB_DEALY12 0x000c
65 #define ADAU1701_SEROCTL_MSB_DEALY16 0x0010
66 #define ADAU1701_SEROCTL_MSB_DEALY_MASK 0x001c
68 #define ADAU1701_SEROCTL_WORD_LEN_24 0x0000
69 #define ADAU1701_SEROCTL_WORD_LEN_20 0x0001
70 #define ADAU1701_SEROCTL_WORD_LEN_16 0x0010
71 #define ADAU1701_SEROCTL_WORD_LEN_MASK 0x0003
73 #define ADAU1701_AUXNPOW_VBPD 0x40
74 #define ADAU1701_AUXNPOW_VRPD 0x20
76 #define ADAU1701_SERICTL_I2S 0
77 #define ADAU1701_SERICTL_LEFTJ 1
78 #define ADAU1701_SERICTL_TDM 2
79 #define ADAU1701_SERICTL_RIGHTJ_24 3
80 #define ADAU1701_SERICTL_RIGHTJ_20 4
81 #define ADAU1701_SERICTL_RIGHTJ_18 5
82 #define ADAU1701_SERICTL_RIGHTJ_16 6
83 #define ADAU1701_SERICTL_MODE_MASK 7
84 #define ADAU1701_SERICTL_INV_BCLK BIT(3)
85 #define ADAU1701_SERICTL_INV_LRCLK BIT(4)
87 #define ADAU1701_OSCIPOW_OPD 0x04
88 #define ADAU1701_DACSET_DACINIT 1
90 #define ADAU1707_CLKDIV_UNSET (-1UL)
92 #define ADAU1701_FIRMWARE "adau1701.bin"
98 unsigned int pll_clkdiv;
102 static const struct snd_kcontrol_new adau1701_controls[] = {
103 SOC_SINGLE("Master Capture Switch", ADAU1701_DSPCTRL, 4, 1, 0),
106 static const struct snd_soc_dapm_widget adau1701_dapm_widgets[] = {
107 SND_SOC_DAPM_DAC("DAC0", "Playback", ADAU1701_AUXNPOW, 3, 1),
108 SND_SOC_DAPM_DAC("DAC1", "Playback", ADAU1701_AUXNPOW, 2, 1),
109 SND_SOC_DAPM_DAC("DAC2", "Playback", ADAU1701_AUXNPOW, 1, 1),
110 SND_SOC_DAPM_DAC("DAC3", "Playback", ADAU1701_AUXNPOW, 0, 1),
111 SND_SOC_DAPM_ADC("ADC", "Capture", ADAU1701_AUXNPOW, 7, 1),
113 SND_SOC_DAPM_OUTPUT("OUT0"),
114 SND_SOC_DAPM_OUTPUT("OUT1"),
115 SND_SOC_DAPM_OUTPUT("OUT2"),
116 SND_SOC_DAPM_OUTPUT("OUT3"),
117 SND_SOC_DAPM_INPUT("IN0"),
118 SND_SOC_DAPM_INPUT("IN1"),
121 static const struct snd_soc_dapm_route adau1701_dapm_routes[] = {
122 { "OUT0", NULL, "DAC0" },
123 { "OUT1", NULL, "DAC1" },
124 { "OUT2", NULL, "DAC2" },
125 { "OUT3", NULL, "DAC3" },
127 { "ADC", NULL, "IN0" },
128 { "ADC", NULL, "IN1" },
131 static unsigned int adau1701_register_size(struct snd_soc_codec *codec,
135 case ADAU1701_DSPCTRL:
136 case ADAU1701_SEROCTL:
137 case ADAU1701_AUXNPOW:
138 case ADAU1701_OSCIPOW:
139 case ADAU1701_DACSET:
141 case ADAU1701_SERICTL:
145 dev_err(codec->dev, "Unsupported register address: %d\n", reg);
149 static int adau1701_write(struct snd_soc_codec *codec, unsigned int reg,
157 size = adau1701_register_size(codec, reg);
161 snd_soc_cache_write(codec, reg, value);
166 for (i = size + 1; i >= 2; --i) {
171 ret = i2c_master_send(to_i2c_client(codec->dev), buf, size + 2);
180 static unsigned int adau1701_read(struct snd_soc_codec *codec, unsigned int reg)
185 ret = snd_soc_cache_read(codec, reg, &value);
192 static int adau1701_reset(struct snd_soc_codec *codec, unsigned int clkdiv)
194 struct adau1701 *adau1701 = snd_soc_codec_get_drvdata(codec);
195 struct i2c_client *client = to_i2c_client(codec->dev);
198 if (clkdiv != ADAU1707_CLKDIV_UNSET &&
199 gpio_is_valid(adau1701->gpio_pll_mode[0]) &&
200 gpio_is_valid(adau1701->gpio_pll_mode[1])) {
203 gpio_set_value(adau1701->gpio_pll_mode[0], 0);
204 gpio_set_value(adau1701->gpio_pll_mode[1], 0);
207 gpio_set_value(adau1701->gpio_pll_mode[0], 0);
208 gpio_set_value(adau1701->gpio_pll_mode[1], 1);
211 gpio_set_value(adau1701->gpio_pll_mode[0], 1);
212 gpio_set_value(adau1701->gpio_pll_mode[1], 0);
214 case 0: /* fallback */
216 gpio_set_value(adau1701->gpio_pll_mode[0], 1);
217 gpio_set_value(adau1701->gpio_pll_mode[1], 1);
222 adau1701->pll_clkdiv = clkdiv;
224 if (gpio_is_valid(adau1701->gpio_nreset)) {
225 gpio_set_value(adau1701->gpio_nreset, 0);
226 /* minimum reset time is 20ns */
228 gpio_set_value(adau1701->gpio_nreset, 1);
229 /* power-up time may be as long as 85ms */
234 * Postpone the firmware download to a point in time when we
235 * know the correct PLL setup
237 if (clkdiv != ADAU1707_CLKDIV_UNSET) {
238 ret = process_sigma_firmware(client, ADAU1701_FIRMWARE);
240 dev_warn(codec->dev, "Failed to load firmware\n");
245 snd_soc_write(codec, ADAU1701_DACSET, ADAU1701_DACSET_DACINIT);
246 snd_soc_write(codec, ADAU1701_DSPCTRL, ADAU1701_DSPCTRL_CR);
251 static int adau1701_set_capture_pcm_format(struct snd_soc_codec *codec,
252 snd_pcm_format_t format)
254 struct adau1701 *adau1701 = snd_soc_codec_get_drvdata(codec);
255 unsigned int mask = ADAU1701_SEROCTL_WORD_LEN_MASK;
259 case SNDRV_PCM_FORMAT_S16_LE:
260 val = ADAU1701_SEROCTL_WORD_LEN_16;
262 case SNDRV_PCM_FORMAT_S20_3LE:
263 val = ADAU1701_SEROCTL_WORD_LEN_20;
265 case SNDRV_PCM_FORMAT_S24_LE:
266 val = ADAU1701_SEROCTL_WORD_LEN_24;
272 if (adau1701->dai_fmt == SND_SOC_DAIFMT_RIGHT_J) {
274 case SNDRV_PCM_FORMAT_S16_LE:
275 val |= ADAU1701_SEROCTL_MSB_DEALY16;
277 case SNDRV_PCM_FORMAT_S20_3LE:
278 val |= ADAU1701_SEROCTL_MSB_DEALY12;
280 case SNDRV_PCM_FORMAT_S24_LE:
281 val |= ADAU1701_SEROCTL_MSB_DEALY8;
284 mask |= ADAU1701_SEROCTL_MSB_DEALY_MASK;
287 snd_soc_update_bits(codec, ADAU1701_SEROCTL, mask, val);
292 static int adau1701_set_playback_pcm_format(struct snd_soc_codec *codec,
293 snd_pcm_format_t format)
295 struct adau1701 *adau1701 = snd_soc_codec_get_drvdata(codec);
298 if (adau1701->dai_fmt != SND_SOC_DAIFMT_RIGHT_J)
302 case SNDRV_PCM_FORMAT_S16_LE:
303 val = ADAU1701_SERICTL_RIGHTJ_16;
305 case SNDRV_PCM_FORMAT_S20_3LE:
306 val = ADAU1701_SERICTL_RIGHTJ_20;
308 case SNDRV_PCM_FORMAT_S24_LE:
309 val = ADAU1701_SERICTL_RIGHTJ_24;
315 snd_soc_update_bits(codec, ADAU1701_SERICTL,
316 ADAU1701_SERICTL_MODE_MASK, val);
321 static int adau1701_hw_params(struct snd_pcm_substream *substream,
322 struct snd_pcm_hw_params *params, struct snd_soc_dai *dai)
324 struct snd_soc_codec *codec = dai->codec;
325 struct adau1701 *adau1701 = snd_soc_codec_get_drvdata(codec);
326 unsigned int clkdiv = adau1701->sysclk / params_rate(params);
327 snd_pcm_format_t format;
332 * If the mclk/lrclk ratio changes, the chip needs updated PLL
333 * mode GPIO settings, and a full reset cycle, including a new
336 if (clkdiv != adau1701->pll_clkdiv) {
337 ret = adau1701_reset(codec, clkdiv);
342 switch (params_rate(params)) {
344 val = ADAU1701_DSPCTRL_SR_192;
347 val = ADAU1701_DSPCTRL_SR_96;
350 val = ADAU1701_DSPCTRL_SR_48;
356 snd_soc_update_bits(codec, ADAU1701_DSPCTRL,
357 ADAU1701_DSPCTRL_SR_MASK, val);
359 format = params_format(params);
360 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
361 return adau1701_set_playback_pcm_format(codec, format);
363 return adau1701_set_capture_pcm_format(codec, format);
366 static int adau1701_set_dai_fmt(struct snd_soc_dai *codec_dai,
369 struct snd_soc_codec *codec = codec_dai->codec;
370 struct adau1701 *adau1701 = snd_soc_codec_get_drvdata(codec);
371 unsigned int serictl = 0x00, seroctl = 0x00;
374 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
375 case SND_SOC_DAIFMT_CBM_CFM:
376 /* master, 64-bits per sample, 1 frame per sample */
377 seroctl |= ADAU1701_SEROCTL_MASTER | ADAU1701_SEROCTL_OBF16
378 | ADAU1701_SEROCTL_OLF1024;
380 case SND_SOC_DAIFMT_CBS_CFS:
386 /* clock inversion */
387 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
388 case SND_SOC_DAIFMT_NB_NF:
389 invert_lrclk = false;
391 case SND_SOC_DAIFMT_NB_IF:
394 case SND_SOC_DAIFMT_IB_NF:
395 invert_lrclk = false;
396 serictl |= ADAU1701_SERICTL_INV_BCLK;
397 seroctl |= ADAU1701_SEROCTL_INV_BCLK;
399 case SND_SOC_DAIFMT_IB_IF:
401 serictl |= ADAU1701_SERICTL_INV_BCLK;
402 seroctl |= ADAU1701_SEROCTL_INV_BCLK;
408 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
409 case SND_SOC_DAIFMT_I2S:
411 case SND_SOC_DAIFMT_LEFT_J:
412 serictl |= ADAU1701_SERICTL_LEFTJ;
413 seroctl |= ADAU1701_SEROCTL_MSB_DEALY0;
414 invert_lrclk = !invert_lrclk;
416 case SND_SOC_DAIFMT_RIGHT_J:
417 serictl |= ADAU1701_SERICTL_RIGHTJ_24;
418 seroctl |= ADAU1701_SEROCTL_MSB_DEALY8;
419 invert_lrclk = !invert_lrclk;
426 seroctl |= ADAU1701_SEROCTL_INV_LRCLK;
427 serictl |= ADAU1701_SERICTL_INV_LRCLK;
430 adau1701->dai_fmt = fmt & SND_SOC_DAIFMT_FORMAT_MASK;
432 snd_soc_write(codec, ADAU1701_SERICTL, serictl);
433 snd_soc_update_bits(codec, ADAU1701_SEROCTL,
434 ~ADAU1701_SEROCTL_WORD_LEN_MASK, seroctl);
439 static int adau1701_set_bias_level(struct snd_soc_codec *codec,
440 enum snd_soc_bias_level level)
442 unsigned int mask = ADAU1701_AUXNPOW_VBPD | ADAU1701_AUXNPOW_VRPD;
445 case SND_SOC_BIAS_ON:
447 case SND_SOC_BIAS_PREPARE:
449 case SND_SOC_BIAS_STANDBY:
450 /* Enable VREF and VREF buffer */
451 snd_soc_update_bits(codec, ADAU1701_AUXNPOW, mask, 0x00);
453 case SND_SOC_BIAS_OFF:
454 /* Disable VREF and VREF buffer */
455 snd_soc_update_bits(codec, ADAU1701_AUXNPOW, mask, mask);
459 codec->dapm.bias_level = level;
463 static int adau1701_digital_mute(struct snd_soc_dai *dai, int mute)
465 struct snd_soc_codec *codec = dai->codec;
466 unsigned int mask = ADAU1701_DSPCTRL_DAM;
474 snd_soc_update_bits(codec, ADAU1701_DSPCTRL, mask, val);
479 static int adau1701_set_sysclk(struct snd_soc_codec *codec, int clk_id,
480 int source, unsigned int freq, int dir)
483 struct adau1701 *adau1701 = snd_soc_codec_get_drvdata(codec);
486 case ADAU1701_CLK_SRC_OSC:
489 case ADAU1701_CLK_SRC_MCLK:
490 val = ADAU1701_OSCIPOW_OPD;
496 snd_soc_update_bits(codec, ADAU1701_OSCIPOW, ADAU1701_OSCIPOW_OPD, val);
497 adau1701->sysclk = freq;
502 #define ADAU1701_RATES (SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_96000 | \
503 SNDRV_PCM_RATE_192000)
505 #define ADAU1701_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
506 SNDRV_PCM_FMTBIT_S24_LE)
508 static const struct snd_soc_dai_ops adau1701_dai_ops = {
509 .set_fmt = adau1701_set_dai_fmt,
510 .hw_params = adau1701_hw_params,
511 .digital_mute = adau1701_digital_mute,
514 static struct snd_soc_dai_driver adau1701_dai = {
517 .stream_name = "Playback",
520 .rates = ADAU1701_RATES,
521 .formats = ADAU1701_FORMATS,
524 .stream_name = "Capture",
527 .rates = ADAU1701_RATES,
528 .formats = ADAU1701_FORMATS,
530 .ops = &adau1701_dai_ops,
531 .symmetric_rates = 1,
535 static const struct of_device_id adau1701_dt_ids[] = {
536 { .compatible = "adi,adau1701", },
539 MODULE_DEVICE_TABLE(of, adau1701_dt_ids);
542 static int adau1701_probe(struct snd_soc_codec *codec)
545 struct adau1701 *adau1701 = snd_soc_codec_get_drvdata(codec);
547 codec->control_data = to_i2c_client(codec->dev);
550 * Let the pll_clkdiv variable default to something that won't happen
551 * at runtime. That way, we can postpone the firmware download from
552 * adau1701_reset() to a point in time when we know the correct PLL
555 adau1701->pll_clkdiv = ADAU1707_CLKDIV_UNSET;
557 /* initalize with pre-configured pll mode settings */
558 ret = adau1701_reset(codec, adau1701->pll_clkdiv);
565 static struct snd_soc_codec_driver adau1701_codec_drv = {
566 .probe = adau1701_probe,
567 .set_bias_level = adau1701_set_bias_level,
568 .idle_bias_off = true,
570 .reg_cache_size = ADAU1701_NUM_REGS,
571 .reg_word_size = sizeof(u16),
573 .controls = adau1701_controls,
574 .num_controls = ARRAY_SIZE(adau1701_controls),
575 .dapm_widgets = adau1701_dapm_widgets,
576 .num_dapm_widgets = ARRAY_SIZE(adau1701_dapm_widgets),
577 .dapm_routes = adau1701_dapm_routes,
578 .num_dapm_routes = ARRAY_SIZE(adau1701_dapm_routes),
580 .write = adau1701_write,
581 .read = adau1701_read,
583 .set_sysclk = adau1701_set_sysclk,
586 static int adau1701_i2c_probe(struct i2c_client *client,
587 const struct i2c_device_id *id)
589 struct adau1701 *adau1701;
590 struct device *dev = &client->dev;
591 int gpio_nreset = -EINVAL;
592 int gpio_pll_mode[2] = { -EINVAL, -EINVAL };
595 adau1701 = devm_kzalloc(dev, sizeof(*adau1701), GFP_KERNEL);
600 gpio_nreset = of_get_named_gpio(dev->of_node, "reset-gpio", 0);
601 if (gpio_nreset < 0 && gpio_nreset != -ENOENT)
604 gpio_pll_mode[0] = of_get_named_gpio(dev->of_node,
605 "adi,pll-mode-gpios", 0);
606 if (gpio_pll_mode[0] < 0 && gpio_pll_mode[0] != -ENOENT)
607 return gpio_pll_mode[0];
609 gpio_pll_mode[1] = of_get_named_gpio(dev->of_node,
610 "adi,pll-mode-gpios", 1);
611 if (gpio_pll_mode[1] < 0 && gpio_pll_mode[1] != -ENOENT)
612 return gpio_pll_mode[1];
615 if (gpio_is_valid(gpio_nreset)) {
616 ret = devm_gpio_request_one(dev, gpio_nreset, GPIOF_OUT_INIT_LOW,
622 if (gpio_is_valid(gpio_pll_mode[0]) &&
623 gpio_is_valid(gpio_pll_mode[1])) {
624 ret = devm_gpio_request_one(dev, gpio_pll_mode[0],
626 "ADAU1701 PLL mode 0");
630 ret = devm_gpio_request_one(dev, gpio_pll_mode[1],
632 "ADAU1701 PLL mode 1");
637 adau1701->gpio_nreset = gpio_nreset;
638 adau1701->gpio_pll_mode[0] = gpio_pll_mode[0];
639 adau1701->gpio_pll_mode[1] = gpio_pll_mode[1];
641 i2c_set_clientdata(client, adau1701);
642 ret = snd_soc_register_codec(&client->dev, &adau1701_codec_drv,
647 static int adau1701_i2c_remove(struct i2c_client *client)
649 snd_soc_unregister_codec(&client->dev);
653 static const struct i2c_device_id adau1701_i2c_id[] = {
657 MODULE_DEVICE_TABLE(i2c, adau1701_i2c_id);
659 static struct i2c_driver adau1701_i2c_driver = {
662 .owner = THIS_MODULE,
663 .of_match_table = of_match_ptr(adau1701_dt_ids),
665 .probe = adau1701_i2c_probe,
666 .remove = adau1701_i2c_remove,
667 .id_table = adau1701_i2c_id,
670 module_i2c_driver(adau1701_i2c_driver);
672 MODULE_DESCRIPTION("ASoC ADAU1701 SigmaDSP driver");
673 MODULE_AUTHOR("Cliff Cai <cliff.cai@analog.com>");
674 MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
675 MODULE_LICENSE("GPL");