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