sound/soc/codecs/wm8711.c

   1 /*
   2  * wm8711.c  --  WM8711 ALSA SoC Audio driver
   3  *
   4  * Copyright 2006 Wolfson Microelectronics
   5  *
   6  * Author: Mike Arthur <linux@wolfsonmicro.com>
   7  *
   8  * Based on wm8731.c by Richard Purdie
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2 as
  12  * published by the Free Software Foundation.
  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/tlv.h>
  29 #include <sound/initval.h>
  30
  31 #include "wm8711.h"
  32
  33 /* codec private data */
  34 struct wm8711_priv {
  35         enum snd_soc_control_type bus_type;
  36         unsigned int sysclk;
  37 };
  38
  39 /*
  40  * wm8711 register cache
  41  * We can't read the WM8711 register space when we are
  42  * using 2 wire for device control, so we cache them instead.
  43  * There is no point in caching the reset register
  44  */
  45 static const u16 wm8711_reg[WM8711_CACHEREGNUM] = {
  46         0x0079, 0x0079, 0x000a, 0x0008,
  47         0x009f, 0x000a, 0x0000, 0x0000
  48 };
  49
  50 #define wm8711_reset(c) snd_soc_write(c, WM8711_RESET, 0)
  51
  52 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1);
  53
  54 static const struct snd_kcontrol_new wm8711_snd_controls[] = {
  55
  56 SOC_DOUBLE_R_TLV("Master Playback Volume", WM8711_LOUT1V, WM8711_ROUT1V,
  57                  0, 127, 0, out_tlv),
  58 SOC_DOUBLE_R("Master Playback ZC Switch", WM8711_LOUT1V, WM8711_ROUT1V,
  59         7, 1, 0),
  60
  61 };
  62
  63 /* Output Mixer */
  64 static const struct snd_kcontrol_new wm8711_output_mixer_controls[] = {
  65 SOC_DAPM_SINGLE("Line Bypass Switch", WM8711_APANA, 3, 1, 0),
  66 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8711_APANA, 4, 1, 0),
  67 };
  68
  69 static const struct snd_soc_dapm_widget wm8711_dapm_widgets[] = {
  70 SND_SOC_DAPM_MIXER("Output Mixer", WM8711_PWR, 4, 1,
  71         &wm8711_output_mixer_controls[0],
  72         ARRAY_SIZE(wm8711_output_mixer_controls)),
  73 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8711_PWR, 3, 1),
  74 SND_SOC_DAPM_OUTPUT("LOUT"),
  75 SND_SOC_DAPM_OUTPUT("LHPOUT"),
  76 SND_SOC_DAPM_OUTPUT("ROUT"),
  77 SND_SOC_DAPM_OUTPUT("RHPOUT"),
  78 };
  79
  80 static const struct snd_soc_dapm_route wm8711_intercon[] = {
  81         /* output mixer */
  82         {"Output Mixer", "Line Bypass Switch", "Line Input"},
  83         {"Output Mixer", "HiFi Playback Switch", "DAC"},
  84
  85         /* outputs */
  86         {"RHPOUT", NULL, "Output Mixer"},
  87         {"ROUT", NULL, "Output Mixer"},
  88         {"LHPOUT", NULL, "Output Mixer"},
  89         {"LOUT", NULL, "Output Mixer"},
  90 };
  91
  92 struct _coeff_div {
  93         u32 mclk;
  94         u32 rate;
  95         u16 fs;
  96         u8 sr:4;
  97         u8 bosr:1;
  98         u8 usb:1;
  99 };
 100
 101 /* codec mclk clock divider coefficients */
 102 static const struct _coeff_div coeff_div[] = {
 103         /* 48k */
 104         {12288000, 48000, 256, 0x0, 0x0, 0x0},
 105         {18432000, 48000, 384, 0x0, 0x1, 0x0},
 106         {12000000, 48000, 250, 0x0, 0x0, 0x1},
 107
 108         /* 32k */
 109         {12288000, 32000, 384, 0x6, 0x0, 0x0},
 110         {18432000, 32000, 576, 0x6, 0x1, 0x0},
 111         {12000000, 32000, 375, 0x6, 0x0, 0x1},
 112
 113         /* 8k */
 114         {12288000, 8000, 1536, 0x3, 0x0, 0x0},
 115         {18432000, 8000, 2304, 0x3, 0x1, 0x0},
 116         {11289600, 8000, 1408, 0xb, 0x0, 0x0},
 117         {16934400, 8000, 2112, 0xb, 0x1, 0x0},
 118         {12000000, 8000, 1500, 0x3, 0x0, 0x1},
 119
 120         /* 96k */
 121         {12288000, 96000, 128, 0x7, 0x0, 0x0},
 122         {18432000, 96000, 192, 0x7, 0x1, 0x0},
 123         {12000000, 96000, 125, 0x7, 0x0, 0x1},
 124
 125         /* 44.1k */
 126         {11289600, 44100, 256, 0x8, 0x0, 0x0},
 127         {16934400, 44100, 384, 0x8, 0x1, 0x0},
 128         {12000000, 44100, 272, 0x8, 0x1, 0x1},
 129
 130         /* 88.2k */
 131         {11289600, 88200, 128, 0xf, 0x0, 0x0},
 132         {16934400, 88200, 192, 0xf, 0x1, 0x0},
 133         {12000000, 88200, 136, 0xf, 0x1, 0x1},
 134 };
 135
 136 static inline int get_coeff(int mclk, int rate)
 137 {
 138         int i;
 139
 140         for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
 141                 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
 142                         return i;
 143         }
 144         return 0;
 145 }
 146
 147 static int wm8711_hw_params(struct snd_pcm_substream *substream,
 148         struct snd_pcm_hw_params *params,
 149         struct snd_soc_dai *dai)
 150 {
 151         struct snd_soc_codec *codec = dai->codec;
 152         struct wm8711_priv *wm8711 =  snd_soc_codec_get_drvdata(codec);
 153         u16 iface = snd_soc_read(codec, WM8711_IFACE) & 0xfffc;
 154         int i = get_coeff(wm8711->sysclk, params_rate(params));
 155         u16 srate = (coeff_div[i].sr << 2) |
 156                 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
 157
 158         snd_soc_write(codec, WM8711_SRATE, srate);
 159
 160         /* bit size */
 161         switch (params_format(params)) {
 162         case SNDRV_PCM_FORMAT_S16_LE:
 163                 break;
 164         case SNDRV_PCM_FORMAT_S20_3LE:
 165                 iface |= 0x0004;
 166                 break;
 167         case SNDRV_PCM_FORMAT_S24_LE:
 168                 iface |= 0x0008;
 169                 break;
 170         }
 171
 172         snd_soc_write(codec, WM8711_IFACE, iface);
 173         return 0;
 174 }
 175
 176 static int wm8711_pcm_prepare(struct snd_pcm_substream *substream,
 177                               struct snd_soc_dai *dai)
 178 {
 179         struct snd_soc_codec *codec = dai->codec;
 180
 181         /* set active */
 182         snd_soc_write(codec, WM8711_ACTIVE, 0x0001);
 183
 184         return 0;
 185 }
 186
 187 static void wm8711_shutdown(struct snd_pcm_substream *substream,
 188                             struct snd_soc_dai *dai)
 189 {
 190         struct snd_soc_codec *codec = dai->codec;
 191
 192         /* deactivate */
 193         if (!codec->active) {
 194                 udelay(50);
 195                 snd_soc_write(codec, WM8711_ACTIVE, 0x0);
 196         }
 197 }
 198
 199 static int wm8711_mute(struct snd_soc_dai *dai, int mute)
 200 {
 201         struct snd_soc_codec *codec = dai->codec;
 202         u16 mute_reg = snd_soc_read(codec, WM8711_APDIGI) & 0xfff7;
 203
 204         if (mute)
 205                 snd_soc_write(codec, WM8711_APDIGI, mute_reg | 0x8);
 206         else
 207                 snd_soc_write(codec, WM8711_APDIGI, mute_reg);
 208
 209         return 0;
 210 }
 211
 212 static int wm8711_set_dai_sysclk(struct snd_soc_dai *codec_dai,
 213                 int clk_id, unsigned int freq, int dir)
 214 {
 215         struct snd_soc_codec *codec = codec_dai->codec;
 216         struct wm8711_priv *wm8711 =  snd_soc_codec_get_drvdata(codec);
 217
 218         switch (freq) {
 219         case 11289600:
 220         case 12000000:
 221         case 12288000:
 222         case 16934400:
 223         case 18432000:
 224                 wm8711->sysclk = freq;
 225                 return 0;
 226         }
 227         return -EINVAL;
 228 }
 229
 230 static int wm8711_set_dai_fmt(struct snd_soc_dai *codec_dai,
 231                 unsigned int fmt)
 232 {
 233         struct snd_soc_codec *codec = codec_dai->codec;
 234         u16 iface = 0;
 235
 236         /* set master/slave audio interface */
 237         switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
 238         case SND_SOC_DAIFMT_CBM_CFM:
 239                 iface |= 0x0040;
 240                 break;
 241         case SND_SOC_DAIFMT_CBS_CFS:
 242                 break;
 243         default:
 244                 return -EINVAL;
 245         }
 246
 247         /* interface format */
 248         switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
 249         case SND_SOC_DAIFMT_I2S:
 250                 iface |= 0x0002;
 251                 break;
 252         case SND_SOC_DAIFMT_RIGHT_J:
 253                 break;
 254         case SND_SOC_DAIFMT_LEFT_J:
 255                 iface |= 0x0001;
 256                 break;
 257         case SND_SOC_DAIFMT_DSP_A:
 258                 iface |= 0x0003;
 259                 break;
 260         case SND_SOC_DAIFMT_DSP_B:
 261                 iface |= 0x0013;
 262                 break;
 263         default:
 264                 return -EINVAL;
 265         }
 266
 267         /* clock inversion */
 268         switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
 269         case SND_SOC_DAIFMT_NB_NF:
 270                 break;
 271         case SND_SOC_DAIFMT_IB_IF:
 272                 iface |= 0x0090;
 273                 break;
 274         case SND_SOC_DAIFMT_IB_NF:
 275                 iface |= 0x0080;
 276                 break;
 277         case SND_SOC_DAIFMT_NB_IF:
 278                 iface |= 0x0010;
 279                 break;
 280         default:
 281                 return -EINVAL;
 282         }
 283
 284         /* set iface */
 285         snd_soc_write(codec, WM8711_IFACE, iface);
 286         return 0;
 287 }
 288
 289
 290 static int wm8711_set_bias_level(struct snd_soc_codec *codec,
 291         enum snd_soc_bias_level level)
 292 {
 293         u16 reg = snd_soc_read(codec, WM8711_PWR) & 0xff7f;
 294
 295         switch (level) {
 296         case SND_SOC_BIAS_ON:
 297                 snd_soc_write(codec, WM8711_PWR, reg);
 298                 break;
 299         case SND_SOC_BIAS_PREPARE:
 300                 break;
 301         case SND_SOC_BIAS_STANDBY:
 302                 snd_soc_write(codec, WM8711_PWR, reg | 0x0040);
 303                 break;
 304         case SND_SOC_BIAS_OFF:
 305                 snd_soc_write(codec, WM8711_ACTIVE, 0x0);
 306                 snd_soc_write(codec, WM8711_PWR, 0xffff);
 307                 break;
 308         }
 309         codec->dapm.bias_level = level;
 310         return 0;
 311 }
 312
 313 #define WM8711_RATES SNDRV_PCM_RATE_8000_96000
 314
 315 #define WM8711_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
 316         SNDRV_PCM_FMTBIT_S24_LE)
 317
 318 static struct snd_soc_dai_ops wm8711_ops = {
 319         .prepare = wm8711_pcm_prepare,
 320         .hw_params = wm8711_hw_params,
 321         .shutdown = wm8711_shutdown,
 322         .digital_mute = wm8711_mute,
 323         .set_sysclk = wm8711_set_dai_sysclk,
 324         .set_fmt = wm8711_set_dai_fmt,
 325 };
 326
 327 static struct snd_soc_dai_driver wm8711_dai = {
 328         .name = "wm8711-hifi",
 329         .playback = {
 330                 .stream_name = "Playback",
 331                 .channels_min = 1,
 332                 .channels_max = 2,
 333                 .rates = WM8711_RATES,
 334                 .formats = WM8711_FORMATS,
 335         },
 336         .ops = &wm8711_ops,
 337 };
 338
 339 static int wm8711_suspend(struct snd_soc_codec *codec, pm_message_t state)
 340 {
 341         snd_soc_write(codec, WM8711_ACTIVE, 0x0);
 342         wm8711_set_bias_level(codec, SND_SOC_BIAS_OFF);
 343         return 0;
 344 }
 345
 346 static int wm8711_resume(struct snd_soc_codec *codec)
 347 {
 348         int i;
 349         u8 data[2];
 350         u16 *cache = codec->reg_cache;
 351
 352         /* Sync reg_cache with the hardware */
 353         for (i = 0; i < ARRAY_SIZE(wm8711_reg); i++) {
 354                 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
 355                 data[1] = cache[i] & 0x00ff;
 356                 codec->hw_write(codec->control_data, data, 2);
 357         }
 358         wm8711_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
 359
 360         return 0;
 361 }
 362
 363 static int wm8711_probe(struct snd_soc_codec *codec)
 364 {
 365         struct wm8711_priv *wm8711 = snd_soc_codec_get_drvdata(codec);
 366         int ret, reg;
 367
 368         ret = snd_soc_codec_set_cache_io(codec, 7, 9, wm8711->bus_type);
 369         if (ret < 0) {
 370                 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
 371                 return ret;
 372         }
 373
 374         ret = wm8711_reset(codec);
 375         if (ret < 0) {
 376                 dev_err(codec->dev, "Failed to issue reset\n");
 377                 return ret;
 378         }
 379
 380         wm8711_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
 381
 382         /* Latch the update bits */
 383         reg = snd_soc_read(codec, WM8711_LOUT1V);
 384         snd_soc_write(codec, WM8711_LOUT1V, reg | 0x0100);
 385         reg = snd_soc_read(codec, WM8711_ROUT1V);
 386         snd_soc_write(codec, WM8711_ROUT1V, reg | 0x0100);
 387
 388         snd_soc_add_controls(codec, wm8711_snd_controls,
 389                              ARRAY_SIZE(wm8711_snd_controls));
 390
 391         return ret;
 392
 393 }
 394
 395 /* power down chip */
 396 static int wm8711_remove(struct snd_soc_codec *codec)
 397 {
 398         wm8711_set_bias_level(codec, SND_SOC_BIAS_OFF);
 399         return 0;
 400 }
 401
 402 static struct snd_soc_codec_driver soc_codec_dev_wm8711 = {
 403         .probe =        wm8711_probe,
 404         .remove =       wm8711_remove,
 405         .suspend =      wm8711_suspend,
 406         .resume =       wm8711_resume,
 407         .set_bias_level = wm8711_set_bias_level,
 408         .reg_cache_size = ARRAY_SIZE(wm8711_reg),
 409         .reg_word_size = sizeof(u16),
 410         .reg_cache_default = wm8711_reg,
 411         .dapm_widgets = wm8711_dapm_widgets,
 412         .num_dapm_widgets = ARRAY_SIZE(wm8711_dapm_widgets),
 413         .dapm_routes = wm8711_intercon,
 414         .num_dapm_routes = ARRAY_SIZE(wm8711_intercon),
 415 };
 416
 417 #if defined(CONFIG_SPI_MASTER)
 418 static int __devinit wm8711_spi_probe(struct spi_device *spi)
 419 {
 420         struct wm8711_priv *wm8711;
 421         int ret;
 422
 423         wm8711 = kzalloc(sizeof(struct wm8711_priv), GFP_KERNEL);
 424         if (wm8711 == NULL)
 425                 return -ENOMEM;
 426
 427         spi_set_drvdata(spi, wm8711);
 428         wm8711->bus_type = SND_SOC_SPI;
 429
 430         ret = snd_soc_register_codec(&spi->dev,
 431                         &soc_codec_dev_wm8711, &wm8711_dai, 1);
 432         if (ret < 0)
 433                 kfree(wm8711);
 434         return ret;
 435 }
 436
 437 static int __devexit wm8711_spi_remove(struct spi_device *spi)
 438 {
 439         snd_soc_unregister_codec(&spi->dev);
 440         kfree(spi_get_drvdata(spi));
 441         return 0;
 442 }
 443
 444 static struct spi_driver wm8711_spi_driver = {
 445         .driver = {
 446                 .name   = "wm8711-codec",
 447                 .owner  = THIS_MODULE,
 448         },
 449         .probe          = wm8711_spi_probe,
 450         .remove         = __devexit_p(wm8711_spi_remove),
 451 };
 452 #endif /* CONFIG_SPI_MASTER */
 453
 454 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
 455 static __devinit int wm8711_i2c_probe(struct i2c_client *client,
 456                                       const struct i2c_device_id *id)
 457 {
 458         struct wm8711_priv *wm8711;
 459         int ret;
 460
 461         wm8711 = kzalloc(sizeof(struct wm8711_priv), GFP_KERNEL);
 462         if (wm8711 == NULL)
 463                 return -ENOMEM;
 464
 465         i2c_set_clientdata(client, wm8711);
 466         wm8711->bus_type = SND_SOC_I2C;
 467
 468         ret =  snd_soc_register_codec(&client->dev,
 469                         &soc_codec_dev_wm8711, &wm8711_dai, 1);
 470         if (ret < 0)
 471                 kfree(wm8711);
 472         return ret;
 473 }
 474
 475 static __devexit int wm8711_i2c_remove(struct i2c_client *client)
 476 {
 477         snd_soc_unregister_codec(&client->dev);
 478         kfree(i2c_get_clientdata(client));
 479         return 0;
 480 }
 481
 482 static const struct i2c_device_id wm8711_i2c_id[] = {
 483         { "wm8711", 0 },
 484         { }
 485 };
 486 MODULE_DEVICE_TABLE(i2c, wm8711_i2c_id);
 487
 488 static struct i2c_driver wm8711_i2c_driver = {
 489         .driver = {
 490                 .name = "wm8711-codec",
 491                 .owner = THIS_MODULE,
 492         },
 493         .probe =    wm8711_i2c_probe,
 494         .remove =   __devexit_p(wm8711_i2c_remove),
 495         .id_table = wm8711_i2c_id,
 496 };
 497 #endif
 498
 499 static int __init wm8711_modinit(void)
 500 {
 501         int ret;
 502 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
 503         ret = i2c_add_driver(&wm8711_i2c_driver);
 504         if (ret != 0) {
 505                 printk(KERN_ERR "Failed to register WM8711 I2C driver: %d\n",
 506                        ret);
 507         }
 508 #endif
 509 #if defined(CONFIG_SPI_MASTER)
 510         ret = spi_register_driver(&wm8711_spi_driver);
 511         if (ret != 0) {
 512                 printk(KERN_ERR "Failed to register WM8711 SPI driver: %d\n",
 513                        ret);
 514         }
 515 #endif
 516         return 0;
 517 }
 518 module_init(wm8711_modinit);
 519
 520 static void __exit wm8711_exit(void)
 521 {
 522 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
 523         i2c_del_driver(&wm8711_i2c_driver);
 524 #endif
 525 #if defined(CONFIG_SPI_MASTER)
 526         spi_unregister_driver(&wm8711_spi_driver);
 527 #endif
 528 }
 529 module_exit(wm8711_exit);
 530
 531 MODULE_DESCRIPTION("ASoC WM8711 driver");
 532 MODULE_AUTHOR("Mike Arthur");
 533 MODULE_LICENSE("GPL");