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