sound/soc/codecs/adau1701.c

   1 /*
   2  * Driver for ADAU1701 SigmaDSP processor
   3  *
   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>
   7  *
   8  * Licensed under the GPL-2 or later.
   9  */
  10
  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>
  16 #include <linux/of.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>
  23
  24 #include "sigmadsp.h"
  25 #include "adau1701.h"
  26
  27 #define ADAU1701_DSPCTRL        0x1c
  28 #define ADAU1701_SEROCTL        0x1e
  29 #define ADAU1701_SERICTL        0x1f
  30
  31 #define ADAU1701_AUXNPOW        0x22
  32
  33 #define ADAU1701_OSCIPOW        0x26
  34 #define ADAU1701_DACSET         0x27
  35
  36 #define ADAU1701_NUM_REGS       0x28
  37
  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
  45
  46 #define ADAU1701_SEROCTL_INV_LRCLK      0x2000
  47 #define ADAU1701_SEROCTL_INV_BCLK       0x1000
  48 #define ADAU1701_SEROCTL_MASTER         0x0800
  49
  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
  55
  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
  60
  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
  67
  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
  72
  73 #define ADAU1701_AUXNPOW_VBPD           0x40
  74 #define ADAU1701_AUXNPOW_VRPD           0x20
  75
  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)
  86
  87 #define ADAU1701_OSCIPOW_OPD            0x04
  88 #define ADAU1701_DACSET_DACINIT         1
  89
  90 #define ADAU1701_FIRMWARE "adau1701.bin"
  91
  92 struct adau1701 {
  93         int gpio_nreset;
  94         unsigned int dai_fmt;
  95 };
  96
  97 static const struct snd_kcontrol_new adau1701_controls[] = {
  98         SOC_SINGLE("Master Capture Switch", ADAU1701_DSPCTRL, 4, 1, 0),
  99 };
 100
 101 static const struct snd_soc_dapm_widget adau1701_dapm_widgets[] = {
 102         SND_SOC_DAPM_DAC("DAC0", "Playback", ADAU1701_AUXNPOW, 3, 1),
 103         SND_SOC_DAPM_DAC("DAC1", "Playback", ADAU1701_AUXNPOW, 2, 1),
 104         SND_SOC_DAPM_DAC("DAC2", "Playback", ADAU1701_AUXNPOW, 1, 1),
 105         SND_SOC_DAPM_DAC("DAC3", "Playback", ADAU1701_AUXNPOW, 0, 1),
 106         SND_SOC_DAPM_ADC("ADC", "Capture", ADAU1701_AUXNPOW, 7, 1),
 107
 108         SND_SOC_DAPM_OUTPUT("OUT0"),
 109         SND_SOC_DAPM_OUTPUT("OUT1"),
 110         SND_SOC_DAPM_OUTPUT("OUT2"),
 111         SND_SOC_DAPM_OUTPUT("OUT3"),
 112         SND_SOC_DAPM_INPUT("IN0"),
 113         SND_SOC_DAPM_INPUT("IN1"),
 114 };
 115
 116 static const struct snd_soc_dapm_route adau1701_dapm_routes[] = {
 117         { "OUT0", NULL, "DAC0" },
 118         { "OUT1", NULL, "DAC1" },
 119         { "OUT2", NULL, "DAC2" },
 120         { "OUT3", NULL, "DAC3" },
 121
 122         { "ADC", NULL, "IN0" },
 123         { "ADC", NULL, "IN1" },
 124 };
 125
 126 static unsigned int adau1701_register_size(struct snd_soc_codec *codec,
 127                 unsigned int reg)
 128 {
 129         switch (reg) {
 130         case ADAU1701_DSPCTRL:
 131         case ADAU1701_SEROCTL:
 132         case ADAU1701_AUXNPOW:
 133         case ADAU1701_OSCIPOW:
 134         case ADAU1701_DACSET:
 135                 return 2;
 136         case ADAU1701_SERICTL:
 137                 return 1;
 138         }
 139
 140         dev_err(codec->dev, "Unsupported register address: %d\n", reg);
 141         return 0;
 142 }
 143
 144 static int adau1701_write(struct snd_soc_codec *codec, unsigned int reg,
 145                 unsigned int value)
 146 {
 147         unsigned int i;
 148         unsigned int size;
 149         uint8_t buf[4];
 150         int ret;
 151
 152         size = adau1701_register_size(codec, reg);
 153         if (size == 0)
 154                 return -EINVAL;
 155
 156         snd_soc_cache_write(codec, reg, value);
 157
 158         buf[0] = 0x08;
 159         buf[1] = reg;
 160
 161         for (i = size + 1; i >= 2; --i) {
 162                 buf[i] = value;
 163                 value >>= 8;
 164         }
 165
 166         ret = i2c_master_send(to_i2c_client(codec->dev), buf, size + 2);
 167         if (ret == size + 2)
 168                 return 0;
 169         else if (ret < 0)
 170                 return ret;
 171         else
 172                 return -EIO;
 173 }
 174
 175 static unsigned int adau1701_read(struct snd_soc_codec *codec, unsigned int reg)
 176 {
 177         unsigned int value;
 178         unsigned int ret;
 179
 180         ret = snd_soc_cache_read(codec, reg, &value);
 181         if (ret)
 182                 return ret;
 183
 184         return value;
 185 }
 186
 187 static int adau1701_reset(struct snd_soc_codec *codec)
 188 {
 189         struct adau1701 *adau1701 = snd_soc_codec_get_drvdata(codec);
 190         struct i2c_client *client = to_i2c_client(codec->dev);
 191         int ret;
 192
 193         if (gpio_is_valid(adau1701->gpio_nreset)) {
 194                 gpio_set_value(adau1701->gpio_nreset, 0);
 195                 /* minimum reset time is 20ns */
 196                 udelay(1);
 197                 gpio_set_value(adau1701->gpio_nreset, 1);
 198                 /* power-up time may be as long as 85ms */
 199                 mdelay(85);
 200         }
 201
 202         ret = process_sigma_firmware(client, ADAU1701_FIRMWARE);
 203         if (ret) {
 204                 dev_warn(codec->dev, "Failed to load firmware\n");
 205                 return ret;
 206         }
 207
 208         snd_soc_write(codec, ADAU1701_DACSET, ADAU1701_DACSET_DACINIT);
 209         snd_soc_write(codec, ADAU1701_DSPCTRL, ADAU1701_DSPCTRL_CR);
 210
 211         return 0;
 212 }
 213
 214 static int adau1701_set_capture_pcm_format(struct snd_soc_codec *codec,
 215                 snd_pcm_format_t format)
 216 {
 217         struct adau1701 *adau1701 = snd_soc_codec_get_drvdata(codec);
 218         unsigned int mask = ADAU1701_SEROCTL_WORD_LEN_MASK;
 219         unsigned int val;
 220
 221         switch (format) {
 222         case SNDRV_PCM_FORMAT_S16_LE:
 223                 val = ADAU1701_SEROCTL_WORD_LEN_16;
 224                 break;
 225         case SNDRV_PCM_FORMAT_S20_3LE:
 226                 val = ADAU1701_SEROCTL_WORD_LEN_20;
 227                 break;
 228         case SNDRV_PCM_FORMAT_S24_LE:
 229                 val = ADAU1701_SEROCTL_WORD_LEN_24;
 230                 break;
 231         default:
 232                 return -EINVAL;
 233         }
 234
 235         if (adau1701->dai_fmt == SND_SOC_DAIFMT_RIGHT_J) {
 236                 switch (format) {
 237                 case SNDRV_PCM_FORMAT_S16_LE:
 238                         val |= ADAU1701_SEROCTL_MSB_DEALY16;
 239                         break;
 240                 case SNDRV_PCM_FORMAT_S20_3LE:
 241                         val |= ADAU1701_SEROCTL_MSB_DEALY12;
 242                         break;
 243                 case SNDRV_PCM_FORMAT_S24_LE:
 244                         val |= ADAU1701_SEROCTL_MSB_DEALY8;
 245                         break;
 246                 }
 247                 mask |= ADAU1701_SEROCTL_MSB_DEALY_MASK;
 248         }
 249
 250         snd_soc_update_bits(codec, ADAU1701_SEROCTL, mask, val);
 251
 252         return 0;
 253 }
 254
 255 static int adau1701_set_playback_pcm_format(struct snd_soc_codec *codec,
 256                         snd_pcm_format_t format)
 257 {
 258         struct adau1701 *adau1701 = snd_soc_codec_get_drvdata(codec);
 259         unsigned int val;
 260
 261         if (adau1701->dai_fmt != SND_SOC_DAIFMT_RIGHT_J)
 262                 return 0;
 263
 264         switch (format) {
 265         case SNDRV_PCM_FORMAT_S16_LE:
 266                 val = ADAU1701_SERICTL_RIGHTJ_16;
 267                 break;
 268         case SNDRV_PCM_FORMAT_S20_3LE:
 269                 val = ADAU1701_SERICTL_RIGHTJ_20;
 270                 break;
 271         case SNDRV_PCM_FORMAT_S24_LE:
 272                 val = ADAU1701_SERICTL_RIGHTJ_24;
 273                 break;
 274         default:
 275                 return -EINVAL;
 276         }
 277
 278         snd_soc_update_bits(codec, ADAU1701_SERICTL,
 279                 ADAU1701_SERICTL_MODE_MASK, val);
 280
 281         return 0;
 282 }
 283
 284 static int adau1701_hw_params(struct snd_pcm_substream *substream,
 285                 struct snd_pcm_hw_params *params, struct snd_soc_dai *dai)
 286 {
 287         struct snd_soc_codec *codec = dai->codec;
 288         snd_pcm_format_t format;
 289         unsigned int val;
 290
 291         switch (params_rate(params)) {
 292         case 192000:
 293                 val = ADAU1701_DSPCTRL_SR_192;
 294                 break;
 295         case 96000:
 296                 val = ADAU1701_DSPCTRL_SR_96;
 297                 break;
 298         case 48000:
 299                 val = ADAU1701_DSPCTRL_SR_48;
 300                 break;
 301         default:
 302                 return -EINVAL;
 303         }
 304
 305         snd_soc_update_bits(codec, ADAU1701_DSPCTRL,
 306                 ADAU1701_DSPCTRL_SR_MASK, val);
 307
 308         format = params_format(params);
 309         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
 310                 return adau1701_set_playback_pcm_format(codec, format);
 311         else
 312                 return adau1701_set_capture_pcm_format(codec, format);
 313 }
 314
 315 static int adau1701_set_dai_fmt(struct snd_soc_dai *codec_dai,
 316                 unsigned int fmt)
 317 {
 318         struct snd_soc_codec *codec = codec_dai->codec;
 319         struct adau1701 *adau1701 = snd_soc_codec_get_drvdata(codec);
 320         unsigned int serictl = 0x00, seroctl = 0x00;
 321         bool invert_lrclk;
 322
 323         switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
 324         case SND_SOC_DAIFMT_CBM_CFM:
 325                 /* master, 64-bits per sample, 1 frame per sample */
 326                 seroctl |= ADAU1701_SEROCTL_MASTER | ADAU1701_SEROCTL_OBF16
 327                                 | ADAU1701_SEROCTL_OLF1024;
 328                 break;
 329         case SND_SOC_DAIFMT_CBS_CFS:
 330                 break;
 331         default:
 332                 return -EINVAL;
 333         }
 334
 335         /* clock inversion */
 336         switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
 337         case SND_SOC_DAIFMT_NB_NF:
 338                 invert_lrclk = false;
 339                 break;
 340         case SND_SOC_DAIFMT_NB_IF:
 341                 invert_lrclk = true;
 342                 break;
 343         case SND_SOC_DAIFMT_IB_NF:
 344                 invert_lrclk = false;
 345                 serictl |= ADAU1701_SERICTL_INV_BCLK;
 346                 seroctl |= ADAU1701_SEROCTL_INV_BCLK;
 347                 break;
 348         case SND_SOC_DAIFMT_IB_IF:
 349                 invert_lrclk = true;
 350                 serictl |= ADAU1701_SERICTL_INV_BCLK;
 351                 seroctl |= ADAU1701_SEROCTL_INV_BCLK;
 352                 break;
 353         default:
 354                 return -EINVAL;
 355         }
 356
 357         switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
 358         case SND_SOC_DAIFMT_I2S:
 359                 break;
 360         case SND_SOC_DAIFMT_LEFT_J:
 361                 serictl |= ADAU1701_SERICTL_LEFTJ;
 362                 seroctl |= ADAU1701_SEROCTL_MSB_DEALY0;
 363                 invert_lrclk = !invert_lrclk;
 364                 break;
 365         case SND_SOC_DAIFMT_RIGHT_J:
 366                 serictl |= ADAU1701_SERICTL_RIGHTJ_24;
 367                 seroctl |= ADAU1701_SEROCTL_MSB_DEALY8;
 368                 invert_lrclk = !invert_lrclk;
 369                 break;
 370         default:
 371                 return -EINVAL;
 372         }
 373
 374         if (invert_lrclk) {
 375                 seroctl |= ADAU1701_SEROCTL_INV_LRCLK;
 376                 serictl |= ADAU1701_SERICTL_INV_LRCLK;
 377         }
 378
 379         adau1701->dai_fmt = fmt & SND_SOC_DAIFMT_FORMAT_MASK;
 380
 381         snd_soc_write(codec, ADAU1701_SERICTL, serictl);
 382         snd_soc_update_bits(codec, ADAU1701_SEROCTL,
 383                 ~ADAU1701_SEROCTL_WORD_LEN_MASK, seroctl);
 384
 385         return 0;
 386 }
 387
 388 static int adau1701_set_bias_level(struct snd_soc_codec *codec,
 389                 enum snd_soc_bias_level level)
 390 {
 391         unsigned int mask = ADAU1701_AUXNPOW_VBPD | ADAU1701_AUXNPOW_VRPD;
 392
 393         switch (level) {
 394         case SND_SOC_BIAS_ON:
 395                 break;
 396         case SND_SOC_BIAS_PREPARE:
 397                 break;
 398         case SND_SOC_BIAS_STANDBY:
 399                 /* Enable VREF and VREF buffer */
 400                 snd_soc_update_bits(codec, ADAU1701_AUXNPOW, mask, 0x00);
 401                 break;
 402         case SND_SOC_BIAS_OFF:
 403                 /* Disable VREF and VREF buffer */
 404                 snd_soc_update_bits(codec, ADAU1701_AUXNPOW, mask, mask);
 405                 break;
 406         }
 407
 408         codec->dapm.bias_level = level;
 409         return 0;
 410 }
 411
 412 static int adau1701_digital_mute(struct snd_soc_dai *dai, int mute)
 413 {
 414         struct snd_soc_codec *codec = dai->codec;
 415         unsigned int mask = ADAU1701_DSPCTRL_DAM;
 416         unsigned int val;
 417
 418         if (mute)
 419                 val = 0;
 420         else
 421                 val = mask;
 422
 423         snd_soc_update_bits(codec, ADAU1701_DSPCTRL, mask, val);
 424
 425         return 0;
 426 }
 427
 428 static int adau1701_set_sysclk(struct snd_soc_codec *codec, int clk_id,
 429         int source, unsigned int freq, int dir)
 430 {
 431         unsigned int val;
 432
 433         switch (clk_id) {
 434         case ADAU1701_CLK_SRC_OSC:
 435                 val = 0x0;
 436                 break;
 437         case ADAU1701_CLK_SRC_MCLK:
 438                 val = ADAU1701_OSCIPOW_OPD;
 439                 break;
 440         default:
 441                 return -EINVAL;
 442         }
 443
 444         snd_soc_update_bits(codec, ADAU1701_OSCIPOW, ADAU1701_OSCIPOW_OPD, val);
 445
 446         return 0;
 447 }
 448
 449 #define ADAU1701_RATES (SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_96000 | \
 450         SNDRV_PCM_RATE_192000)
 451
 452 #define ADAU1701_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
 453         SNDRV_PCM_FMTBIT_S24_LE)
 454
 455 static const struct snd_soc_dai_ops adau1701_dai_ops = {
 456         .set_fmt        = adau1701_set_dai_fmt,
 457         .hw_params      = adau1701_hw_params,
 458         .digital_mute   = adau1701_digital_mute,
 459 };
 460
 461 static struct snd_soc_dai_driver adau1701_dai = {
 462         .name = "adau1701",
 463         .playback = {
 464                 .stream_name = "Playback",
 465                 .channels_min = 2,
 466                 .channels_max = 8,
 467                 .rates = ADAU1701_RATES,
 468                 .formats = ADAU1701_FORMATS,
 469         },
 470         .capture = {
 471                 .stream_name = "Capture",
 472                 .channels_min = 2,
 473                 .channels_max = 8,
 474                 .rates = ADAU1701_RATES,
 475                 .formats = ADAU1701_FORMATS,
 476         },
 477         .ops = &adau1701_dai_ops,
 478         .symmetric_rates = 1,
 479 };
 480
 481 #ifdef CONFIG_OF
 482 static const struct of_device_id adau1701_dt_ids[] = {
 483         { .compatible = "adi,adau1701", },
 484         { }
 485 };
 486 MODULE_DEVICE_TABLE(of, adau1701_dt_ids);
 487 #endif
 488
 489 static int adau1701_probe(struct snd_soc_codec *codec)
 490 {
 491         int ret;
 492
 493         codec->control_data = to_i2c_client(codec->dev);
 494
 495         ret = adau1701_reset(codec);
 496         if (ret)
 497                 return ret;
 498
 499         return 0;
 500 }
 501
 502 static struct snd_soc_codec_driver adau1701_codec_drv = {
 503         .probe                  = adau1701_probe,
 504         .set_bias_level         = adau1701_set_bias_level,
 505         .idle_bias_off          = true,
 506
 507         .reg_cache_size         = ADAU1701_NUM_REGS,
 508         .reg_word_size          = sizeof(u16),
 509
 510         .controls               = adau1701_controls,
 511         .num_controls           = ARRAY_SIZE(adau1701_controls),
 512         .dapm_widgets           = adau1701_dapm_widgets,
 513         .num_dapm_widgets       = ARRAY_SIZE(adau1701_dapm_widgets),
 514         .dapm_routes            = adau1701_dapm_routes,
 515         .num_dapm_routes        = ARRAY_SIZE(adau1701_dapm_routes),
 516
 517         .write                  = adau1701_write,
 518         .read                   = adau1701_read,
 519
 520         .set_sysclk             = adau1701_set_sysclk,
 521 };
 522
 523 static int adau1701_i2c_probe(struct i2c_client *client,
 524                               const struct i2c_device_id *id)
 525 {
 526         struct adau1701 *adau1701;
 527         struct device *dev = &client->dev;
 528         int gpio_nreset = -EINVAL;
 529         int ret;
 530
 531         adau1701 = devm_kzalloc(dev, sizeof(*adau1701), GFP_KERNEL);
 532         if (!adau1701)
 533                 return -ENOMEM;
 534
 535         if (dev->of_node) {
 536                 gpio_nreset = of_get_named_gpio(dev->of_node, "reset-gpio", 0);
 537                 if (gpio_nreset < 0 && gpio_nreset != -ENOENT)
 538                         return gpio_nreset;
 539         }
 540
 541         if (gpio_is_valid(gpio_nreset)) {
 542                 ret = devm_gpio_request_one(dev, gpio_nreset, GPIOF_OUT_INIT_LOW,
 543                                             "ADAU1701 Reset");
 544                 if (ret < 0)
 545                         return ret;
 546         }
 547
 548         adau1701->gpio_nreset = gpio_nreset;
 549
 550         i2c_set_clientdata(client, adau1701);
 551         ret = snd_soc_register_codec(&client->dev, &adau1701_codec_drv,
 552                         &adau1701_dai, 1);
 553         return ret;
 554 }
 555
 556 static int adau1701_i2c_remove(struct i2c_client *client)
 557 {
 558         snd_soc_unregister_codec(&client->dev);
 559         return 0;
 560 }
 561
 562 static const struct i2c_device_id adau1701_i2c_id[] = {
 563         { "adau1701", 0 },
 564         { }
 565 };
 566 MODULE_DEVICE_TABLE(i2c, adau1701_i2c_id);
 567
 568 static struct i2c_driver adau1701_i2c_driver = {
 569         .driver = {
 570                 .name   = "adau1701",
 571                 .owner  = THIS_MODULE,
 572                 .of_match_table = of_match_ptr(adau1701_dt_ids),
 573         },
 574         .probe          = adau1701_i2c_probe,
 575         .remove         = adau1701_i2c_remove,
 576         .id_table       = adau1701_i2c_id,
 577 };
 578
 579 module_i2c_driver(adau1701_i2c_driver);
 580
 581 MODULE_DESCRIPTION("ASoC ADAU1701 SigmaDSP driver");
 582 MODULE_AUTHOR("Cliff Cai <cliff.cai@analog.com>");
 583 MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
 584 MODULE_LICENSE("GPL");