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