1 /* 2 * wm8711.c -- WM8711 ALSA SoC Audio driver 3 * 4 * Copyright 2006 Wolfson Microelectronics 5 * 6 * Author: Mike Arthur <Mike.Arthur@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/regmap.h> 22 #include <linux/spi/spi.h> 23 #include <linux/slab.h> 24 #include <linux/of_device.h> 25 #include <sound/core.h> 26 #include <sound/pcm.h> 27 #include <sound/pcm_params.h> 28 #include <sound/soc.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 struct regmap *regmap; 37 unsigned int sysclk; 38 }; 39 40 /* 41 * wm8711 register cache 42 * We can't read the WM8711 register space when we are 43 * using 2 wire for device control, so we cache them instead. 44 * There is no point in caching the reset register 45 */ 46 static const struct reg_default wm8711_reg_defaults[] = { 47 { 0, 0x0079 }, { 1, 0x0079 }, { 2, 0x000a }, { 3, 0x0008 }, 48 { 4, 0x009f }, { 5, 0x000a }, { 6, 0x0000 }, { 7, 0x0000 }, 49 }; 50 51 static bool wm8711_volatile(struct device *dev, unsigned int reg) 52 { 53 switch (reg) { 54 case WM8711_RESET: 55 return true; 56 default: 57 return false; 58 } 59 } 60 61 #define wm8711_reset(c) snd_soc_write(c, WM8711_RESET, 0) 62 63 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1); 64 65 static const struct snd_kcontrol_new wm8711_snd_controls[] = { 66 67 SOC_DOUBLE_R_TLV("Master Playback Volume", WM8711_LOUT1V, WM8711_ROUT1V, 68 0, 127, 0, out_tlv), 69 SOC_DOUBLE_R("Master Playback ZC Switch", WM8711_LOUT1V, WM8711_ROUT1V, 70 7, 1, 0), 71 72 }; 73 74 /* Output Mixer */ 75 static const struct snd_kcontrol_new wm8711_output_mixer_controls[] = { 76 SOC_DAPM_SINGLE("Line Bypass Switch", WM8711_APANA, 3, 1, 0), 77 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8711_APANA, 4, 1, 0), 78 }; 79 80 static const struct snd_soc_dapm_widget wm8711_dapm_widgets[] = { 81 SND_SOC_DAPM_MIXER("Output Mixer", WM8711_PWR, 4, 1, 82 &wm8711_output_mixer_controls[0], 83 ARRAY_SIZE(wm8711_output_mixer_controls)), 84 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8711_PWR, 3, 1), 85 SND_SOC_DAPM_OUTPUT("LOUT"), 86 SND_SOC_DAPM_OUTPUT("LHPOUT"), 87 SND_SOC_DAPM_OUTPUT("ROUT"), 88 SND_SOC_DAPM_OUTPUT("RHPOUT"), 89 }; 90 91 static const struct snd_soc_dapm_route wm8711_intercon[] = { 92 /* output mixer */ 93 {"Output Mixer", "Line Bypass Switch", "Line Input"}, 94 {"Output Mixer", "HiFi Playback Switch", "DAC"}, 95 96 /* outputs */ 97 {"RHPOUT", NULL, "Output Mixer"}, 98 {"ROUT", NULL, "Output Mixer"}, 99 {"LHPOUT", NULL, "Output Mixer"}, 100 {"LOUT", NULL, "Output Mixer"}, 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) & 0xfff3; 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_width(params)) { 173 case 16: 174 break; 175 case 20: 176 iface |= 0x0004; 177 break; 178 case 24: 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 (!snd_soc_codec_is_active(codec)) { 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 = snd_soc_read(codec, WM8711_IFACE) & 0x000c; 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 static int wm8711_set_bias_level(struct snd_soc_codec *codec, 301 enum snd_soc_bias_level level) 302 { 303 struct wm8711_priv *wm8711 = snd_soc_codec_get_drvdata(codec); 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 if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) 314 regcache_sync(wm8711->regmap); 315 316 snd_soc_write(codec, WM8711_PWR, reg | 0x0040); 317 break; 318 case SND_SOC_BIAS_OFF: 319 snd_soc_write(codec, WM8711_ACTIVE, 0x0); 320 snd_soc_write(codec, WM8711_PWR, 0xffff); 321 break; 322 } 323 codec->dapm.bias_level = level; 324 return 0; 325 } 326 327 #define WM8711_RATES SNDRV_PCM_RATE_8000_96000 328 329 #define WM8711_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\ 330 SNDRV_PCM_FMTBIT_S24_LE) 331 332 static const struct snd_soc_dai_ops wm8711_ops = { 333 .prepare = wm8711_pcm_prepare, 334 .hw_params = wm8711_hw_params, 335 .shutdown = wm8711_shutdown, 336 .digital_mute = wm8711_mute, 337 .set_sysclk = wm8711_set_dai_sysclk, 338 .set_fmt = wm8711_set_dai_fmt, 339 }; 340 341 static struct snd_soc_dai_driver wm8711_dai = { 342 .name = "wm8711-hifi", 343 .playback = { 344 .stream_name = "Playback", 345 .channels_min = 1, 346 .channels_max = 2, 347 .rates = WM8711_RATES, 348 .formats = WM8711_FORMATS, 349 }, 350 .ops = &wm8711_ops, 351 }; 352 353 static int wm8711_suspend(struct snd_soc_codec *codec) 354 { 355 snd_soc_write(codec, WM8711_ACTIVE, 0x0); 356 wm8711_set_bias_level(codec, SND_SOC_BIAS_OFF); 357 return 0; 358 } 359 360 static int wm8711_resume(struct snd_soc_codec *codec) 361 { 362 wm8711_set_bias_level(codec, SND_SOC_BIAS_STANDBY); 363 return 0; 364 } 365 366 static int wm8711_probe(struct snd_soc_codec *codec) 367 { 368 int ret; 369 370 ret = wm8711_reset(codec); 371 if (ret < 0) { 372 dev_err(codec->dev, "Failed to issue reset\n"); 373 return ret; 374 } 375 376 wm8711_set_bias_level(codec, SND_SOC_BIAS_STANDBY); 377 378 /* Latch the update bits */ 379 snd_soc_update_bits(codec, WM8711_LOUT1V, 0x0100, 0x0100); 380 snd_soc_update_bits(codec, WM8711_ROUT1V, 0x0100, 0x0100); 381 382 return ret; 383 384 } 385 386 /* power down chip */ 387 static int wm8711_remove(struct snd_soc_codec *codec) 388 { 389 wm8711_set_bias_level(codec, SND_SOC_BIAS_OFF); 390 return 0; 391 } 392 393 static struct snd_soc_codec_driver soc_codec_dev_wm8711 = { 394 .probe = wm8711_probe, 395 .remove = wm8711_remove, 396 .suspend = wm8711_suspend, 397 .resume = wm8711_resume, 398 .set_bias_level = wm8711_set_bias_level, 399 .controls = wm8711_snd_controls, 400 .num_controls = ARRAY_SIZE(wm8711_snd_controls), 401 .dapm_widgets = wm8711_dapm_widgets, 402 .num_dapm_widgets = ARRAY_SIZE(wm8711_dapm_widgets), 403 .dapm_routes = wm8711_intercon, 404 .num_dapm_routes = ARRAY_SIZE(wm8711_intercon), 405 }; 406 407 static const struct of_device_id wm8711_of_match[] = { 408 { .compatible = "wlf,wm8711", }, 409 { } 410 }; 411 MODULE_DEVICE_TABLE(of, wm8711_of_match); 412 413 static const struct regmap_config wm8711_regmap = { 414 .reg_bits = 7, 415 .val_bits = 9, 416 .max_register = WM8711_RESET, 417 418 .reg_defaults = wm8711_reg_defaults, 419 .num_reg_defaults = ARRAY_SIZE(wm8711_reg_defaults), 420 .cache_type = REGCACHE_RBTREE, 421 422 .volatile_reg = wm8711_volatile, 423 }; 424 425 #if defined(CONFIG_SPI_MASTER) 426 static int wm8711_spi_probe(struct spi_device *spi) 427 { 428 struct wm8711_priv *wm8711; 429 int ret; 430 431 wm8711 = devm_kzalloc(&spi->dev, sizeof(struct wm8711_priv), 432 GFP_KERNEL); 433 if (wm8711 == NULL) 434 return -ENOMEM; 435 436 wm8711->regmap = devm_regmap_init_spi(spi, &wm8711_regmap); 437 if (IS_ERR(wm8711->regmap)) 438 return PTR_ERR(wm8711->regmap); 439 440 spi_set_drvdata(spi, wm8711); 441 442 ret = snd_soc_register_codec(&spi->dev, 443 &soc_codec_dev_wm8711, &wm8711_dai, 1); 444 445 return ret; 446 } 447 448 static int wm8711_spi_remove(struct spi_device *spi) 449 { 450 snd_soc_unregister_codec(&spi->dev); 451 452 return 0; 453 } 454 455 static struct spi_driver wm8711_spi_driver = { 456 .driver = { 457 .name = "wm8711", 458 .owner = THIS_MODULE, 459 .of_match_table = wm8711_of_match, 460 }, 461 .probe = wm8711_spi_probe, 462 .remove = wm8711_spi_remove, 463 }; 464 #endif /* CONFIG_SPI_MASTER */ 465 466 #if IS_ENABLED(CONFIG_I2C) 467 static int wm8711_i2c_probe(struct i2c_client *client, 468 const struct i2c_device_id *id) 469 { 470 struct wm8711_priv *wm8711; 471 int ret; 472 473 wm8711 = devm_kzalloc(&client->dev, sizeof(struct wm8711_priv), 474 GFP_KERNEL); 475 if (wm8711 == NULL) 476 return -ENOMEM; 477 478 wm8711->regmap = devm_regmap_init_i2c(client, &wm8711_regmap); 479 if (IS_ERR(wm8711->regmap)) 480 return PTR_ERR(wm8711->regmap); 481 482 i2c_set_clientdata(client, wm8711); 483 484 ret = snd_soc_register_codec(&client->dev, 485 &soc_codec_dev_wm8711, &wm8711_dai, 1); 486 487 return ret; 488 } 489 490 static int wm8711_i2c_remove(struct i2c_client *client) 491 { 492 snd_soc_unregister_codec(&client->dev); 493 return 0; 494 } 495 496 static const struct i2c_device_id wm8711_i2c_id[] = { 497 { "wm8711", 0 }, 498 { } 499 }; 500 MODULE_DEVICE_TABLE(i2c, wm8711_i2c_id); 501 502 static struct i2c_driver wm8711_i2c_driver = { 503 .driver = { 504 .name = "wm8711", 505 .owner = THIS_MODULE, 506 .of_match_table = wm8711_of_match, 507 }, 508 .probe = wm8711_i2c_probe, 509 .remove = wm8711_i2c_remove, 510 .id_table = wm8711_i2c_id, 511 }; 512 #endif 513 514 static int __init wm8711_modinit(void) 515 { 516 int ret; 517 #if IS_ENABLED(CONFIG_I2C) 518 ret = i2c_add_driver(&wm8711_i2c_driver); 519 if (ret != 0) { 520 printk(KERN_ERR "Failed to register WM8711 I2C driver: %d\n", 521 ret); 522 } 523 #endif 524 #if defined(CONFIG_SPI_MASTER) 525 ret = spi_register_driver(&wm8711_spi_driver); 526 if (ret != 0) { 527 printk(KERN_ERR "Failed to register WM8711 SPI driver: %d\n", 528 ret); 529 } 530 #endif 531 return 0; 532 } 533 module_init(wm8711_modinit); 534 535 static void __exit wm8711_exit(void) 536 { 537 #if IS_ENABLED(CONFIG_I2C) 538 i2c_del_driver(&wm8711_i2c_driver); 539 #endif 540 #if defined(CONFIG_SPI_MASTER) 541 spi_unregister_driver(&wm8711_spi_driver); 542 #endif 543 } 544 module_exit(wm8711_exit); 545 546 MODULE_DESCRIPTION("ASoC WM8711 driver"); 547 MODULE_AUTHOR("Mike Arthur"); 548 MODULE_LICENSE("GPL"); 549