sound/soc/codecs/wm8776.c

   1 /*
   2  * wm8776.c  --  WM8776 ALSA SoC Audio driver
   3  *
   4  * Copyright 2009 Wolfson Microelectronics plc
   5  *
   6  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  *
  12  * TODO: Input ALC/limiter support
  13  */
  14
  15 #include <linux/module.h>
  16 #include <linux/moduleparam.h>
  17 #include <linux/init.h>
  18 #include <linux/delay.h>
  19 #include <linux/pm.h>
  20 #include <linux/i2c.h>
  21 #include <linux/platform_device.h>
  22 #include <linux/spi/spi.h>
  23 #include <linux/slab.h>
  24 #include <sound/core.h>
  25 #include <sound/pcm.h>
  26 #include <sound/pcm_params.h>
  27 #include <sound/soc.h>
  28 #include <sound/soc-dapm.h>
  29 #include <sound/initval.h>
  30 #include <sound/tlv.h>
  31
  32 #include "wm8776.h"
  33
  34 /* codec private data */
  35 struct wm8776_priv {
  36         enum snd_soc_control_type control_type;
  37         u16 reg_cache[WM8776_CACHEREGNUM];
  38         int sysclk[2];
  39 };
  40
  41 static const u16 wm8776_reg[WM8776_CACHEREGNUM] = {
  42         0x79, 0x79, 0x79, 0xff, 0xff,  /* 4 */
  43         0xff, 0x00, 0x90, 0x00, 0x00,  /* 9 */
  44         0x22, 0x22, 0x22, 0x08, 0xcf,  /* 14 */
  45         0xcf, 0x7b, 0x00, 0x32, 0x00,  /* 19 */
  46         0xa6, 0x01, 0x01
  47 };
  48
  49 static int wm8776_reset(struct snd_soc_codec *codec)
  50 {
  51         return snd_soc_write(codec, WM8776_RESET, 0);
  52 }
  53
  54 static const DECLARE_TLV_DB_SCALE(hp_tlv, -12100, 100, 1);
  55 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12750, 50, 1);
  56 static const DECLARE_TLV_DB_SCALE(adc_tlv, -10350, 50, 1);
  57
  58 static const struct snd_kcontrol_new wm8776_snd_controls[] = {
  59 SOC_DOUBLE_R_TLV("Headphone Playback Volume", WM8776_HPLVOL, WM8776_HPRVOL,
  60                  0, 127, 0, hp_tlv),
  61 SOC_DOUBLE_R_TLV("Digital Playback Volume", WM8776_DACLVOL, WM8776_DACRVOL,
  62                  0, 255, 0, dac_tlv),
  63 SOC_SINGLE("Digital Playback ZC Switch", WM8776_DACCTRL1, 0, 1, 0),
  64
  65 SOC_SINGLE("Deemphasis Switch", WM8776_DACCTRL2, 0, 1, 0),
  66
  67 SOC_DOUBLE_R_TLV("Capture Volume", WM8776_ADCLVOL, WM8776_ADCRVOL,
  68                  0, 255, 0, adc_tlv),
  69 SOC_DOUBLE("Capture Switch", WM8776_ADCMUX, 7, 6, 1, 1),
  70 SOC_DOUBLE_R("Capture ZC Switch", WM8776_ADCLVOL, WM8776_ADCRVOL, 8, 1, 0),
  71 SOC_SINGLE("Capture HPF Switch", WM8776_ADCIFCTRL, 8, 1, 1),
  72 };
  73
  74 static const struct snd_kcontrol_new inmix_controls[] = {
  75 SOC_DAPM_SINGLE("AIN1 Switch", WM8776_ADCMUX, 0, 1, 0),
  76 SOC_DAPM_SINGLE("AIN2 Switch", WM8776_ADCMUX, 1, 1, 0),
  77 SOC_DAPM_SINGLE("AIN3 Switch", WM8776_ADCMUX, 2, 1, 0),
  78 SOC_DAPM_SINGLE("AIN4 Switch", WM8776_ADCMUX, 3, 1, 0),
  79 SOC_DAPM_SINGLE("AIN5 Switch", WM8776_ADCMUX, 4, 1, 0),
  80 };
  81
  82 static const struct snd_kcontrol_new outmix_controls[] = {
  83 SOC_DAPM_SINGLE("DAC Switch", WM8776_OUTMUX, 0, 1, 0),
  84 SOC_DAPM_SINGLE("AUX Switch", WM8776_OUTMUX, 1, 1, 0),
  85 SOC_DAPM_SINGLE("Bypass Switch", WM8776_OUTMUX, 2, 1, 0),
  86 };
  87
  88 static const struct snd_soc_dapm_widget wm8776_dapm_widgets[] = {
  89 SND_SOC_DAPM_INPUT("AUX"),
  90
  91 SND_SOC_DAPM_INPUT("AIN1"),
  92 SND_SOC_DAPM_INPUT("AIN2"),
  93 SND_SOC_DAPM_INPUT("AIN3"),
  94 SND_SOC_DAPM_INPUT("AIN4"),
  95 SND_SOC_DAPM_INPUT("AIN5"),
  96
  97 SND_SOC_DAPM_MIXER("Input Mixer", WM8776_PWRDOWN, 6, 1,
  98                    inmix_controls, ARRAY_SIZE(inmix_controls)),
  99
 100 SND_SOC_DAPM_ADC("ADC", "Capture", WM8776_PWRDOWN, 1, 1),
 101 SND_SOC_DAPM_DAC("DAC", "Playback", WM8776_PWRDOWN, 2, 1),
 102
 103 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM, 0, 0,
 104                    outmix_controls, ARRAY_SIZE(outmix_controls)),
 105
 106 SND_SOC_DAPM_PGA("Headphone PGA", WM8776_PWRDOWN, 3, 1, NULL, 0),
 107
 108 SND_SOC_DAPM_OUTPUT("VOUT"),
 109
 110 SND_SOC_DAPM_OUTPUT("HPOUTL"),
 111 SND_SOC_DAPM_OUTPUT("HPOUTR"),
 112 };
 113
 114 static const struct snd_soc_dapm_route routes[] = {
 115         { "Input Mixer", "AIN1 Switch", "AIN1" },
 116         { "Input Mixer", "AIN2 Switch", "AIN2" },
 117         { "Input Mixer", "AIN3 Switch", "AIN3" },
 118         { "Input Mixer", "AIN4 Switch", "AIN4" },
 119         { "Input Mixer", "AIN5 Switch", "AIN5" },
 120
 121         { "ADC", NULL, "Input Mixer" },
 122
 123         { "Output Mixer", "DAC Switch", "DAC" },
 124         { "Output Mixer", "AUX Switch", "AUX" },
 125         { "Output Mixer", "Bypass Switch", "Input Mixer" },
 126
 127         { "VOUT", NULL, "Output Mixer" },
 128
 129         { "Headphone PGA", NULL, "Output Mixer" },
 130
 131         { "HPOUTL", NULL, "Headphone PGA" },
 132         { "HPOUTR", NULL, "Headphone PGA" },
 133 };
 134
 135 static int wm8776_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
 136 {
 137         struct snd_soc_codec *codec = dai->codec;
 138         int reg, iface, master;
 139
 140         switch (dai->driver->id) {
 141         case WM8776_DAI_DAC:
 142                 reg = WM8776_DACIFCTRL;
 143                 master = 0x80;
 144                 break;
 145         case WM8776_DAI_ADC:
 146                 reg = WM8776_ADCIFCTRL;
 147                 master = 0x100;
 148                 break;
 149         default:
 150                 return -EINVAL;
 151         }
 152
 153         iface = 0;
 154
 155         switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
 156         case SND_SOC_DAIFMT_CBM_CFM:
 157                 break;
 158         case SND_SOC_DAIFMT_CBS_CFS:
 159                 master = 0;
 160                 break;
 161         default:
 162                 return -EINVAL;
 163         }
 164
 165         switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
 166         case SND_SOC_DAIFMT_I2S:
 167                 iface |= 0x0002;
 168                 break;
 169         case SND_SOC_DAIFMT_RIGHT_J:
 170                 break;
 171         case SND_SOC_DAIFMT_LEFT_J:
 172                 iface |= 0x0001;
 173                 break;
 174                 /* FIXME: CHECK A/B */
 175         case SND_SOC_DAIFMT_DSP_A:
 176                 iface |= 0x0003;
 177                 break;
 178         case SND_SOC_DAIFMT_DSP_B:
 179                 iface |= 0x0007;
 180                 break;
 181         default:
 182                 return -EINVAL;
 183         }
 184
 185         switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
 186         case SND_SOC_DAIFMT_NB_NF:
 187                 break;
 188         case SND_SOC_DAIFMT_IB_IF:
 189                 iface |= 0x00c;
 190                 break;
 191         case SND_SOC_DAIFMT_IB_NF:
 192                 iface |= 0x008;
 193                 break;
 194         case SND_SOC_DAIFMT_NB_IF:
 195                 iface |= 0x004;
 196                 break;
 197         default:
 198                 return -EINVAL;
 199         }
 200
 201         /* Finally, write out the values */
 202         snd_soc_update_bits(codec, reg, 0xf, iface);
 203         snd_soc_update_bits(codec, WM8776_MSTRCTRL, 0x180, master);
 204
 205         return 0;
 206 }
 207
 208 static int mclk_ratios[] = {
 209         128,
 210         192,
 211         256,
 212         384,
 213         512,
 214         768,
 215 };
 216
 217 static int wm8776_hw_params(struct snd_pcm_substream *substream,
 218                             struct snd_pcm_hw_params *params,
 219                             struct snd_soc_dai *dai)
 220 {
 221         struct snd_soc_codec *codec = dai->codec;
 222         struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
 223         int iface_reg, iface;
 224         int ratio_shift, master;
 225         int i;
 226
 227         iface = 0;
 228
 229         switch (dai->driver->id) {
 230         case WM8776_DAI_DAC:
 231                 iface_reg = WM8776_DACIFCTRL;
 232                 master = 0x80;
 233                 ratio_shift = 4;
 234                 break;
 235         case WM8776_DAI_ADC:
 236                 iface_reg = WM8776_ADCIFCTRL;
 237                 master = 0x100;
 238                 ratio_shift = 0;
 239                 break;
 240         default:
 241                 return -EINVAL;
 242         }
 243
 244
 245         /* Set word length */
 246         switch (params_format(params)) {
 247         case SNDRV_PCM_FORMAT_S16_LE:
 248                 break;
 249         case SNDRV_PCM_FORMAT_S20_3LE:
 250                 iface |= 0x10;
 251                 break;
 252         case SNDRV_PCM_FORMAT_S24_LE:
 253                 iface |= 0x20;
 254                 break;
 255         case SNDRV_PCM_FORMAT_S32_LE:
 256                 iface |= 0x30;
 257                 break;
 258         }
 259
 260         /* Only need to set MCLK/LRCLK ratio if we're master */
 261         if (snd_soc_read(codec, WM8776_MSTRCTRL) & master) {
 262                 for (i = 0; i < ARRAY_SIZE(mclk_ratios); i++) {
 263                         if (wm8776->sysclk[dai->driver->id] / params_rate(params)
 264                             == mclk_ratios[i])
 265                                 break;
 266                 }
 267
 268                 if (i == ARRAY_SIZE(mclk_ratios)) {
 269                         dev_err(codec->dev,
 270                                 "Unable to configure MCLK ratio %d/%d\n",
 271                                 wm8776->sysclk[dai->driver->id], params_rate(params));
 272                         return -EINVAL;
 273                 }
 274
 275                 dev_dbg(codec->dev, "MCLK is %dfs\n", mclk_ratios[i]);
 276
 277                 snd_soc_update_bits(codec, WM8776_MSTRCTRL,
 278                                     0x7 << ratio_shift, i << ratio_shift);
 279         } else {
 280                 dev_dbg(codec->dev, "DAI in slave mode\n");
 281         }
 282
 283         snd_soc_update_bits(codec, iface_reg, 0x30, iface);
 284
 285         return 0;
 286 }
 287
 288 static int wm8776_mute(struct snd_soc_dai *dai, int mute)
 289 {
 290         struct snd_soc_codec *codec = dai->codec;
 291
 292         return snd_soc_write(codec, WM8776_DACMUTE, !!mute);
 293 }
 294
 295 static int wm8776_set_sysclk(struct snd_soc_dai *dai,
 296                              int clk_id, unsigned int freq, int dir)
 297 {
 298         struct snd_soc_codec *codec = dai->codec;
 299         struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
 300
 301         BUG_ON(dai->driver->id >= ARRAY_SIZE(wm8776->sysclk));
 302
 303         wm8776->sysclk[dai->driver->id] = freq;
 304
 305         return 0;
 306 }
 307
 308 static int wm8776_set_bias_level(struct snd_soc_codec *codec,
 309                                  enum snd_soc_bias_level level)
 310 {
 311         switch (level) {
 312         case SND_SOC_BIAS_ON:
 313                 break;
 314         case SND_SOC_BIAS_PREPARE:
 315                 break;
 316         case SND_SOC_BIAS_STANDBY:
 317                 if (codec->bias_level == SND_SOC_BIAS_OFF) {
 318                         /* Disable the global powerdown; DAPM does the rest */
 319                         snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 0);
 320                 }
 321
 322                 break;
 323         case SND_SOC_BIAS_OFF:
 324                 snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 1);
 325                 break;
 326         }
 327
 328         codec->bias_level = level;
 329         return 0;
 330 }
 331
 332 #define WM8776_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
 333                       SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
 334                       SNDRV_PCM_RATE_96000)
 335
 336
 337 #define WM8776_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
 338                         SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
 339
 340 static struct snd_soc_dai_ops wm8776_dac_ops = {
 341         .digital_mute   = wm8776_mute,
 342         .hw_params      = wm8776_hw_params,
 343         .set_fmt        = wm8776_set_fmt,
 344         .set_sysclk     = wm8776_set_sysclk,
 345 };
 346
 347 static struct snd_soc_dai_ops wm8776_adc_ops = {
 348         .hw_params      = wm8776_hw_params,
 349         .set_fmt        = wm8776_set_fmt,
 350         .set_sysclk     = wm8776_set_sysclk,
 351 };
 352
 353 static struct snd_soc_dai_driver wm8776_dai[] = {
 354         {
 355                 .name = "wm8776-hifi-playback",
 356                 .id     = WM8776_DAI_DAC,
 357                 .playback = {
 358                         .stream_name = "Playback",
 359                         .channels_min = 2,
 360                         .channels_max = 2,
 361                         .rates = WM8776_RATES,
 362                         .formats = WM8776_FORMATS,
 363                 },
 364                 .ops = &wm8776_dac_ops,
 365         },
 366         {
 367                 .name = "wm8776-hifi-capture",
 368                 .id     = WM8776_DAI_ADC,
 369                 .capture = {
 370                         .stream_name = "Capture",
 371                         .channels_min = 2,
 372                         .channels_max = 2,
 373                         .rates = WM8776_RATES,
 374                         .formats = WM8776_FORMATS,
 375                 },
 376                 .ops = &wm8776_adc_ops,
 377         },
 378 };
 379
 380 #ifdef CONFIG_PM
 381 static int wm8776_suspend(struct snd_soc_codec *codec, pm_message_t state)
 382 {
 383         wm8776_set_bias_level(codec, SND_SOC_BIAS_OFF);
 384
 385         return 0;
 386 }
 387
 388 static int wm8776_resume(struct snd_soc_codec *codec)
 389 {
 390         int i;
 391         u8 data[2];
 392         u16 *cache = codec->reg_cache;
 393
 394         /* Sync reg_cache with the hardware */
 395         for (i = 0; i < ARRAY_SIZE(wm8776_reg); i++) {
 396                 if (cache[i] == wm8776_reg[i])
 397                         continue;
 398                 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
 399                 data[1] = cache[i] & 0x00ff;
 400                 codec->hw_write(codec->control_data, data, 2);
 401         }
 402
 403         wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
 404
 405         return 0;
 406 }
 407 #else
 408 #define wm8776_suspend NULL
 409 #define wm8776_resume NULL
 410 #endif
 411
 412 static int wm8776_probe(struct snd_soc_codec *codec)
 413 {
 414         struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
 415         int ret = 0;
 416
 417         ret = snd_soc_codec_set_cache_io(codec, 7, 9, wm8776->control_type);
 418         if (ret < 0) {
 419                 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
 420                 return ret;
 421         }
 422
 423         ret = wm8776_reset(codec);
 424         if (ret < 0) {
 425                 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
 426                 return ret;
 427         }
 428
 429         wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
 430
 431         /* Latch the update bits; right channel only since we always
 432          * update both. */
 433         snd_soc_update_bits(codec, WM8776_HPRVOL, 0x100, 0x100);
 434         snd_soc_update_bits(codec, WM8776_DACRVOL, 0x100, 0x100);
 435
 436         snd_soc_add_controls(codec, wm8776_snd_controls,
 437                              ARRAY_SIZE(wm8776_snd_controls));
 438         snd_soc_dapm_new_controls(codec, wm8776_dapm_widgets,
 439                                   ARRAY_SIZE(wm8776_dapm_widgets));
 440         snd_soc_dapm_add_routes(codec, routes, ARRAY_SIZE(routes));
 441
 442         return ret;
 443 }
 444
 445 /* power down chip */
 446 static int wm8776_remove(struct snd_soc_codec *codec)
 447 {
 448         wm8776_set_bias_level(codec, SND_SOC_BIAS_OFF);
 449         return 0;
 450 }
 451
 452 static struct snd_soc_codec_driver soc_codec_dev_wm8776 = {
 453         .probe =        wm8776_probe,
 454         .remove =       wm8776_remove,
 455         .suspend =      wm8776_suspend,
 456         .resume =       wm8776_resume,
 457         .set_bias_level = wm8776_set_bias_level,
 458         .reg_cache_size = sizeof(wm8776_reg),
 459         .reg_word_size = sizeof(u16),
 460         .reg_cache_default = wm8776_reg,
 461 };
 462
 463 #if defined(CONFIG_SPI_MASTER)
 464 static int __devinit wm8776_spi_probe(struct spi_device *spi)
 465 {
 466         struct wm8776_priv *wm8776;
 467         int ret;
 468
 469         wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
 470         if (wm8776 == NULL)
 471                 return -ENOMEM;
 472
 473         wm8776->control_type = SND_SOC_SPI;
 474         spi_set_drvdata(spi, wm8776);
 475
 476         ret = snd_soc_register_codec(&spi->dev,
 477                         &soc_codec_dev_wm8776, wm8776_dai, ARRAY_SIZE(wm8776_dai));
 478         if (ret < 0)
 479                 kfree(wm8776);
 480         return ret;
 481 }
 482
 483 static int __devexit wm8776_spi_remove(struct spi_device *spi)
 484 {
 485         snd_soc_unregister_codec(&spi->dev);
 486         kfree(spi_get_drvdata(spi));
 487         return 0;
 488 }
 489
 490 static struct spi_driver wm8776_spi_driver = {
 491         .driver = {
 492                 .name   = "wm8776-codec",
 493                 .bus    = &spi_bus_type,
 494                 .owner  = THIS_MODULE,
 495         },
 496         .probe          = wm8776_spi_probe,
 497         .remove         = __devexit_p(wm8776_spi_remove),
 498 };
 499 #endif /* CONFIG_SPI_MASTER */
 500
 501 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
 502 static __devinit int wm8776_i2c_probe(struct i2c_client *i2c,
 503                                       const struct i2c_device_id *id)
 504 {
 505         struct wm8776_priv *wm8776;
 506         int ret;
 507
 508         wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
 509         if (wm8776 == NULL)
 510                 return -ENOMEM;
 511
 512         i2c_set_clientdata(i2c, wm8776);
 513         wm8776->control_type = SND_SOC_I2C;
 514
 515         ret =  snd_soc_register_codec(&i2c->dev,
 516                         &soc_codec_dev_wm8776, wm8776_dai, ARRAY_SIZE(wm8776_dai));
 517         if (ret < 0)
 518                 kfree(wm8776);
 519         return ret;
 520 }
 521
 522 static __devexit int wm8776_i2c_remove(struct i2c_client *client)
 523 {
 524         snd_soc_unregister_codec(&client->dev);
 525         kfree(i2c_get_clientdata(client));
 526         return 0;
 527 }
 528
 529 static const struct i2c_device_id wm8776_i2c_id[] = {
 530         { "wm8776", 0 },
 531         { }
 532 };
 533 MODULE_DEVICE_TABLE(i2c, wm8776_i2c_id);
 534
 535 static struct i2c_driver wm8776_i2c_driver = {
 536         .driver = {
 537                 .name = "wm8776-codec",
 538                 .owner = THIS_MODULE,
 539         },
 540         .probe =    wm8776_i2c_probe,
 541         .remove =   __devexit_p(wm8776_i2c_remove),
 542         .id_table = wm8776_i2c_id,
 543 };
 544 #endif
 545
 546 static int __init wm8776_modinit(void)
 547 {
 548         int ret = 0;
 549 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
 550         ret = i2c_add_driver(&wm8776_i2c_driver);
 551         if (ret != 0) {
 552                 printk(KERN_ERR "Failed to register wm8776 I2C driver: %d\n",
 553                        ret);
 554         }
 555 #endif
 556 #if defined(CONFIG_SPI_MASTER)
 557         ret = spi_register_driver(&wm8776_spi_driver);
 558         if (ret != 0) {
 559                 printk(KERN_ERR "Failed to register wm8776 SPI driver: %d\n",
 560                        ret);
 561         }
 562 #endif
 563         return ret;
 564 }
 565 module_init(wm8776_modinit);
 566
 567 static void __exit wm8776_exit(void)
 568 {
 569 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
 570         i2c_del_driver(&wm8776_i2c_driver);
 571 #endif
 572 #if defined(CONFIG_SPI_MASTER)
 573         spi_unregister_driver(&wm8776_spi_driver);
 574 #endif
 575 }
 576 module_exit(wm8776_exit);
 577
 578 MODULE_DESCRIPTION("ASoC WM8776 driver");
 579 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
 580 MODULE_LICENSE("GPL");