1 /* 2 * Texas Instruments TLV320AIC26 low power audio CODEC 3 * ALSA SoC CODEC driver 4 * 5 * Copyright (C) 2008 Secret Lab Technologies Ltd. 6 */ 7 8 #include <linux/module.h> 9 #include <linux/moduleparam.h> 10 #include <linux/init.h> 11 #include <linux/delay.h> 12 #include <linux/pm.h> 13 #include <linux/device.h> 14 #include <linux/sysfs.h> 15 #include <linux/spi/spi.h> 16 #include <sound/core.h> 17 #include <sound/pcm.h> 18 #include <sound/pcm_params.h> 19 #include <sound/soc.h> 20 #include <sound/soc-dapm.h> 21 #include <sound/soc-of-simple.h> 22 #include <sound/initval.h> 23 24 #include "tlv320aic26.h" 25 26 MODULE_DESCRIPTION("ASoC TLV320AIC26 codec driver"); 27 MODULE_AUTHOR("Grant Likely <grant.likely@secretlab.ca>"); 28 MODULE_LICENSE("GPL"); 29 30 /* AIC26 driver private data */ 31 struct aic26 { 32 struct spi_device *spi; 33 struct snd_soc_codec codec; 34 u16 reg_cache[AIC26_NUM_REGS]; /* shadow registers */ 35 int master; 36 int datfm; 37 int mclk; 38 39 /* Keyclick parameters */ 40 int keyclick_amplitude; 41 int keyclick_freq; 42 int keyclick_len; 43 }; 44 45 /* --------------------------------------------------------------------- 46 * Register access routines 47 */ 48 static unsigned int aic26_reg_read(struct snd_soc_codec *codec, 49 unsigned int reg) 50 { 51 struct aic26 *aic26 = codec->private_data; 52 u16 *cache = codec->reg_cache; 53 u16 cmd, value; 54 u8 buffer[2]; 55 int rc; 56 57 if (reg >= AIC26_NUM_REGS) { 58 WARN_ON_ONCE(1); 59 return 0; 60 } 61 62 /* Do SPI transfer; first 16bits are command; remaining is 63 * register contents */ 64 cmd = AIC26_READ_COMMAND_WORD(reg); 65 buffer[0] = (cmd >> 8) & 0xff; 66 buffer[1] = cmd & 0xff; 67 rc = spi_write_then_read(aic26->spi, buffer, 2, buffer, 2); 68 if (rc) { 69 dev_err(&aic26->spi->dev, "AIC26 reg read error\n"); 70 return -EIO; 71 } 72 value = (buffer[0] << 8) | buffer[1]; 73 74 /* Update the cache before returning with the value */ 75 cache[reg] = value; 76 return value; 77 } 78 79 static unsigned int aic26_reg_read_cache(struct snd_soc_codec *codec, 80 unsigned int reg) 81 { 82 u16 *cache = codec->reg_cache; 83 84 if (reg >= AIC26_NUM_REGS) { 85 WARN_ON_ONCE(1); 86 return 0; 87 } 88 89 return cache[reg]; 90 } 91 92 static int aic26_reg_write(struct snd_soc_codec *codec, unsigned int reg, 93 unsigned int value) 94 { 95 struct aic26 *aic26 = codec->private_data; 96 u16 *cache = codec->reg_cache; 97 u16 cmd; 98 u8 buffer[4]; 99 int rc; 100 101 if (reg >= AIC26_NUM_REGS) { 102 WARN_ON_ONCE(1); 103 return -EINVAL; 104 } 105 106 /* Do SPI transfer; first 16bits are command; remaining is data 107 * to write into register */ 108 cmd = AIC26_WRITE_COMMAND_WORD(reg); 109 buffer[0] = (cmd >> 8) & 0xff; 110 buffer[1] = cmd & 0xff; 111 buffer[2] = value >> 8; 112 buffer[3] = value; 113 rc = spi_write(aic26->spi, buffer, 4); 114 if (rc) { 115 dev_err(&aic26->spi->dev, "AIC26 reg read error\n"); 116 return -EIO; 117 } 118 119 /* update cache before returning */ 120 cache[reg] = value; 121 return 0; 122 } 123 124 /* --------------------------------------------------------------------- 125 * Digital Audio Interface Operations 126 */ 127 static int aic26_hw_params(struct snd_pcm_substream *substream, 128 struct snd_pcm_hw_params *params) 129 { 130 struct snd_soc_pcm_runtime *rtd = substream->private_data; 131 struct snd_soc_device *socdev = rtd->socdev; 132 struct snd_soc_codec *codec = socdev->codec; 133 struct aic26 *aic26 = codec->private_data; 134 int fsref, divisor, wlen, pval, jval, dval, qval; 135 u16 reg; 136 137 dev_dbg(&aic26->spi->dev, "aic26_hw_params(substream=%p, params=%p)\n", 138 substream, params); 139 dev_dbg(&aic26->spi->dev, "rate=%i format=%i\n", params_rate(params), 140 params_format(params)); 141 142 switch (params_rate(params)) { 143 case 8000: fsref = 48000; divisor = AIC26_DIV_6; break; 144 case 11025: fsref = 44100; divisor = AIC26_DIV_4; break; 145 case 12000: fsref = 48000; divisor = AIC26_DIV_4; break; 146 case 16000: fsref = 48000; divisor = AIC26_DIV_3; break; 147 case 22050: fsref = 44100; divisor = AIC26_DIV_2; break; 148 case 24000: fsref = 48000; divisor = AIC26_DIV_2; break; 149 case 32000: fsref = 48000; divisor = AIC26_DIV_1_5; break; 150 case 44100: fsref = 44100; divisor = AIC26_DIV_1; break; 151 case 48000: fsref = 48000; divisor = AIC26_DIV_1; break; 152 default: 153 dev_dbg(&aic26->spi->dev, "bad rate\n"); return -EINVAL; 154 } 155 156 /* select data word length */ 157 switch (params_format(params)) { 158 case SNDRV_PCM_FORMAT_S8: wlen = AIC26_WLEN_16; break; 159 case SNDRV_PCM_FORMAT_S16_BE: wlen = AIC26_WLEN_16; break; 160 case SNDRV_PCM_FORMAT_S24_BE: wlen = AIC26_WLEN_24; break; 161 case SNDRV_PCM_FORMAT_S32_BE: wlen = AIC26_WLEN_32; break; 162 default: 163 dev_dbg(&aic26->spi->dev, "bad format\n"); return -EINVAL; 164 } 165 166 /* Configure PLL */ 167 pval = 1; 168 jval = (fsref == 44100) ? 7 : 8; 169 dval = (fsref == 44100) ? 5264 : 1920; 170 qval = 0; 171 reg = 0x8000 | qval << 11 | pval << 8 | jval << 2; 172 aic26_reg_write(codec, AIC26_REG_PLL_PROG1, reg); 173 reg = dval << 2; 174 aic26_reg_write(codec, AIC26_REG_PLL_PROG2, reg); 175 176 /* Audio Control 3 (master mode, fsref rate) */ 177 reg = aic26_reg_read_cache(codec, AIC26_REG_AUDIO_CTRL3); 178 reg &= ~0xf800; 179 if (aic26->master) 180 reg |= 0x0800; 181 if (fsref == 48000) 182 reg |= 0x2000; 183 aic26_reg_write(codec, AIC26_REG_AUDIO_CTRL3, reg); 184 185 /* Audio Control 1 (FSref divisor) */ 186 reg = aic26_reg_read_cache(codec, AIC26_REG_AUDIO_CTRL1); 187 reg &= ~0x0fff; 188 reg |= wlen | aic26->datfm | (divisor << 3) | divisor; 189 aic26_reg_write(codec, AIC26_REG_AUDIO_CTRL1, reg); 190 191 return 0; 192 } 193 194 /** 195 * aic26_mute - Mute control to reduce noise when changing audio format 196 */ 197 static int aic26_mute(struct snd_soc_dai *dai, int mute) 198 { 199 struct snd_soc_codec *codec = dai->codec; 200 struct aic26 *aic26 = codec->private_data; 201 u16 reg = aic26_reg_read_cache(codec, AIC26_REG_DAC_GAIN); 202 203 dev_dbg(&aic26->spi->dev, "aic26_mute(dai=%p, mute=%i)\n", 204 dai, mute); 205 206 if (mute) 207 reg |= 0x8080; 208 else 209 reg &= ~0x8080; 210 aic26_reg_write(codec, AIC26_REG_DAC_GAIN, reg); 211 212 return 0; 213 } 214 215 static int aic26_set_sysclk(struct snd_soc_dai *codec_dai, 216 int clk_id, unsigned int freq, int dir) 217 { 218 struct snd_soc_codec *codec = codec_dai->codec; 219 struct aic26 *aic26 = codec->private_data; 220 221 dev_dbg(&aic26->spi->dev, "aic26_set_sysclk(dai=%p, clk_id==%i," 222 " freq=%i, dir=%i)\n", 223 codec_dai, clk_id, freq, dir); 224 225 /* MCLK needs to fall between 2MHz and 50 MHz */ 226 if ((freq < 2000000) || (freq > 50000000)) 227 return -EINVAL; 228 229 aic26->mclk = freq; 230 return 0; 231 } 232 233 static int aic26_set_fmt(struct snd_soc_dai *codec_dai, unsigned int fmt) 234 { 235 struct snd_soc_codec *codec = codec_dai->codec; 236 struct aic26 *aic26 = codec->private_data; 237 238 dev_dbg(&aic26->spi->dev, "aic26_set_fmt(dai=%p, fmt==%i)\n", 239 codec_dai, fmt); 240 241 /* set master/slave audio interface */ 242 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) { 243 case SND_SOC_DAIFMT_CBM_CFM: aic26->master = 1; break; 244 case SND_SOC_DAIFMT_CBS_CFS: aic26->master = 0; break; 245 default: 246 dev_dbg(&aic26->spi->dev, "bad master\n"); return -EINVAL; 247 } 248 249 /* interface format */ 250 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) { 251 case SND_SOC_DAIFMT_I2S: aic26->datfm = AIC26_DATFM_I2S; break; 252 case SND_SOC_DAIFMT_DSP_A: aic26->datfm = AIC26_DATFM_DSP; break; 253 case SND_SOC_DAIFMT_RIGHT_J: aic26->datfm = AIC26_DATFM_RIGHTJ; break; 254 case SND_SOC_DAIFMT_LEFT_J: aic26->datfm = AIC26_DATFM_LEFTJ; break; 255 default: 256 dev_dbg(&aic26->spi->dev, "bad format\n"); return -EINVAL; 257 } 258 259 return 0; 260 } 261 262 /* --------------------------------------------------------------------- 263 * Digital Audio Interface Definition 264 */ 265 #define AIC26_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 |\ 266 SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 |\ 267 SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\ 268 SNDRV_PCM_RATE_48000) 269 #define AIC26_FORMATS (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_BE |\ 270 SNDRV_PCM_FMTBIT_S24_BE | SNDRV_PCM_FMTBIT_S32_BE) 271 272 struct snd_soc_dai aic26_dai = { 273 .name = "tlv320aic26", 274 .playback = { 275 .stream_name = "Playback", 276 .channels_min = 2, 277 .channels_max = 2, 278 .rates = AIC26_RATES, 279 .formats = AIC26_FORMATS, 280 }, 281 .capture = { 282 .stream_name = "Capture", 283 .channels_min = 2, 284 .channels_max = 2, 285 .rates = AIC26_RATES, 286 .formats = AIC26_FORMATS, 287 }, 288 .ops = { 289 .hw_params = aic26_hw_params, 290 }, 291 .dai_ops = { 292 .digital_mute = aic26_mute, 293 .set_sysclk = aic26_set_sysclk, 294 .set_fmt = aic26_set_fmt, 295 }, 296 }; 297 EXPORT_SYMBOL_GPL(aic26_dai); 298 299 /* --------------------------------------------------------------------- 300 * ALSA controls 301 */ 302 static const char *aic26_capture_src_text[] = {"Mic", "Aux"}; 303 static const struct soc_enum aic26_capture_src_enum = 304 SOC_ENUM_SINGLE(AIC26_REG_AUDIO_CTRL1, 12, 2, aic26_capture_src_text); 305 306 static const struct snd_kcontrol_new aic26_snd_controls[] = { 307 /* Output */ 308 SOC_DOUBLE("PCM Playback Volume", AIC26_REG_DAC_GAIN, 8, 0, 0x7f, 1), 309 SOC_DOUBLE("PCM Playback Switch", AIC26_REG_DAC_GAIN, 15, 7, 1, 1), 310 SOC_SINGLE("PCM Capture Volume", AIC26_REG_ADC_GAIN, 8, 0x7f, 0), 311 SOC_SINGLE("PCM Capture Mute", AIC26_REG_ADC_GAIN, 15, 1, 1), 312 SOC_SINGLE("Keyclick activate", AIC26_REG_AUDIO_CTRL2, 15, 0x1, 0), 313 SOC_SINGLE("Keyclick amplitude", AIC26_REG_AUDIO_CTRL2, 12, 0x7, 0), 314 SOC_SINGLE("Keyclick frequency", AIC26_REG_AUDIO_CTRL2, 8, 0x7, 0), 315 SOC_SINGLE("Keyclick period", AIC26_REG_AUDIO_CTRL2, 4, 0xf, 0), 316 SOC_ENUM("Capture Source", aic26_capture_src_enum), 317 }; 318 319 /* --------------------------------------------------------------------- 320 * SoC CODEC portion of driver: probe and release routines 321 */ 322 static int aic26_probe(struct platform_device *pdev) 323 { 324 struct snd_soc_device *socdev = platform_get_drvdata(pdev); 325 struct snd_soc_codec *codec; 326 struct snd_kcontrol *kcontrol; 327 struct aic26 *aic26; 328 int i, ret, err; 329 330 dev_info(&pdev->dev, "Probing AIC26 SoC CODEC driver\n"); 331 dev_dbg(&pdev->dev, "socdev=%p\n", socdev); 332 dev_dbg(&pdev->dev, "codec_data=%p\n", socdev->codec_data); 333 334 /* Fetch the relevant aic26 private data here (it's already been 335 * stored in the .codec pointer) */ 336 aic26 = socdev->codec_data; 337 if (aic26 == NULL) { 338 dev_err(&pdev->dev, "aic26: missing codec pointer\n"); 339 return -ENODEV; 340 } 341 codec = &aic26->codec; 342 socdev->codec = codec; 343 344 dev_dbg(&pdev->dev, "Registering PCMs, dev=%p, socdev->dev=%p\n", 345 &pdev->dev, socdev->dev); 346 /* register pcms */ 347 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1); 348 if (ret < 0) { 349 dev_err(&pdev->dev, "aic26: failed to create pcms\n"); 350 return -ENODEV; 351 } 352 353 /* register controls */ 354 dev_dbg(&pdev->dev, "Registering controls\n"); 355 for (i = 0; i < ARRAY_SIZE(aic26_snd_controls); i++) { 356 kcontrol = snd_soc_cnew(&aic26_snd_controls[i], codec, NULL); 357 err = snd_ctl_add(codec->card, kcontrol); 358 WARN_ON(err < 0); 359 } 360 361 /* CODEC is setup, we can register the card now */ 362 dev_dbg(&pdev->dev, "Registering card\n"); 363 ret = snd_soc_register_card(socdev); 364 if (ret < 0) { 365 dev_err(&pdev->dev, "aic26: failed to register card\n"); 366 goto card_err; 367 } 368 return 0; 369 370 card_err: 371 snd_soc_free_pcms(socdev); 372 return ret; 373 } 374 375 static int aic26_remove(struct platform_device *pdev) 376 { 377 struct snd_soc_device *socdev = platform_get_drvdata(pdev); 378 snd_soc_free_pcms(socdev); 379 return 0; 380 } 381 382 struct snd_soc_codec_device aic26_soc_codec_dev = { 383 .probe = aic26_probe, 384 .remove = aic26_remove, 385 }; 386 EXPORT_SYMBOL_GPL(aic26_soc_codec_dev); 387 388 /* --------------------------------------------------------------------- 389 * SPI device portion of driver: sysfs files for debugging 390 */ 391 392 static ssize_t aic26_keyclick_show(struct device *dev, 393 struct device_attribute *attr, char *buf) 394 { 395 struct aic26 *aic26 = dev_get_drvdata(dev); 396 int val, amp, freq, len; 397 398 val = aic26_reg_read_cache(&aic26->codec, AIC26_REG_AUDIO_CTRL2); 399 amp = (val >> 12) & 0x7; 400 freq = (125 << ((val >> 8) & 0x7)) >> 1; 401 len = 2 * (1 + ((val >> 4) & 0xf)); 402 403 return sprintf(buf, "amp=%x freq=%iHz len=%iclks\n", amp, freq, len); 404 } 405 406 /* Any write to the keyclick attribute will trigger the keyclick event */ 407 static ssize_t aic26_keyclick_set(struct device *dev, 408 struct device_attribute *attr, 409 const char *buf, size_t count) 410 { 411 struct aic26 *aic26 = dev_get_drvdata(dev); 412 int val; 413 414 val = aic26_reg_read_cache(&aic26->codec, AIC26_REG_AUDIO_CTRL2); 415 val |= 0x8000; 416 aic26_reg_write(&aic26->codec, AIC26_REG_AUDIO_CTRL2, val); 417 418 return count; 419 } 420 421 static DEVICE_ATTR(keyclick, 0644, aic26_keyclick_show, aic26_keyclick_set); 422 423 /* --------------------------------------------------------------------- 424 * SPI device portion of driver: probe and release routines and SPI 425 * driver registration. 426 */ 427 static int aic26_spi_probe(struct spi_device *spi) 428 { 429 struct aic26 *aic26; 430 int rc, i, reg; 431 432 dev_dbg(&spi->dev, "probing tlv320aic26 spi device\n"); 433 434 /* Allocate driver data */ 435 aic26 = kzalloc(sizeof *aic26, GFP_KERNEL); 436 if (!aic26) 437 return -ENOMEM; 438 439 /* Initialize the driver data */ 440 aic26->spi = spi; 441 dev_set_drvdata(&spi->dev, aic26); 442 443 /* Setup what we can in the codec structure so that the register 444 * access functions will work as expected. More will be filled 445 * out when it is probed by the SoC CODEC part of this driver */ 446 aic26->codec.private_data = aic26; 447 aic26->codec.name = "aic26"; 448 aic26->codec.owner = THIS_MODULE; 449 aic26->codec.dai = &aic26_dai; 450 aic26->codec.num_dai = 1; 451 aic26->codec.read = aic26_reg_read; 452 aic26->codec.write = aic26_reg_write; 453 aic26->master = 1; 454 mutex_init(&aic26->codec.mutex); 455 INIT_LIST_HEAD(&aic26->codec.dapm_widgets); 456 INIT_LIST_HEAD(&aic26->codec.dapm_paths); 457 aic26->codec.reg_cache_size = AIC26_NUM_REGS; 458 aic26->codec.reg_cache = aic26->reg_cache; 459 460 /* Reset the codec to power on defaults */ 461 aic26_reg_write(&aic26->codec, AIC26_REG_RESET, 0xBB00); 462 463 /* Power up CODEC */ 464 aic26_reg_write(&aic26->codec, AIC26_REG_POWER_CTRL, 0); 465 466 /* Audio Control 3 (master mode, fsref rate) */ 467 reg = aic26_reg_read(&aic26->codec, AIC26_REG_AUDIO_CTRL3); 468 reg &= ~0xf800; 469 reg |= 0x0800; /* set master mode */ 470 aic26_reg_write(&aic26->codec, AIC26_REG_AUDIO_CTRL3, reg); 471 472 /* Fill register cache */ 473 for (i = 0; i < ARRAY_SIZE(aic26->reg_cache); i++) 474 aic26_reg_read(&aic26->codec, i); 475 476 /* Register the sysfs files for debugging */ 477 /* Create SysFS files */ 478 rc = device_create_file(&spi->dev, &dev_attr_keyclick); 479 if (rc) 480 dev_info(&spi->dev, "error creating sysfs files\n"); 481 482 #if defined(CONFIG_SND_SOC_OF_SIMPLE) 483 /* Tell the of_soc helper about this codec */ 484 of_snd_soc_register_codec(&aic26_soc_codec_dev, aic26, &aic26_dai, 485 spi->dev.archdata.of_node); 486 #endif 487 488 dev_dbg(&spi->dev, "SPI device initialized\n"); 489 return 0; 490 } 491 492 static int aic26_spi_remove(struct spi_device *spi) 493 { 494 struct aic26 *aic26 = dev_get_drvdata(&spi->dev); 495 496 kfree(aic26); 497 498 return 0; 499 } 500 501 static struct spi_driver aic26_spi = { 502 .driver = { 503 .name = "tlv320aic26", 504 .owner = THIS_MODULE, 505 }, 506 .probe = aic26_spi_probe, 507 .remove = aic26_spi_remove, 508 }; 509 510 static int __init aic26_init(void) 511 { 512 return spi_register_driver(&aic26_spi); 513 } 514 module_init(aic26_init); 515 516 static void __exit aic26_exit(void) 517 { 518 spi_unregister_driver(&aic26_spi); 519 } 520 module_exit(aic26_exit); 521