sound/soc/codecs/ad1836.c

   1 /*
   2  * File:         sound/soc/codecs/ad1836.c
   3  * Author:       Barry Song <Barry.Song@analog.com>
   4  *
   5  * Created:      Aug 04 2009
   6  * Description:  Driver for AD1836 sound chip
   7  *
   8  * Modified:
   9  *               Copyright 2009 Analog Devices Inc.
  10  *
  11  * Bugs:         Enter bugs at http://blackfin.uclinux.org/
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  */
  18
  19 #include <linux/init.h>
  20 #include <linux/module.h>
  21 #include <linux/kernel.h>
  22 #include <linux/device.h>
  23 #include <sound/core.h>
  24 #include <sound/pcm.h>
  25 #include <sound/pcm_params.h>
  26 #include <sound/initval.h>
  27 #include <sound/soc.h>
  28 #include <sound/tlv.h>
  29 #include <sound/soc-dapm.h>
  30 #include <linux/spi/spi.h>
  31 #include "ad1836.h"
  32
  33 /* codec private data */
  34 struct ad1836_priv {
  35         struct snd_soc_codec codec;
  36         u16 reg_cache[AD1836_NUM_REGS];
  37 };
  38
  39 static struct snd_soc_codec *ad1836_codec;
  40 struct snd_soc_codec_device soc_codec_dev_ad1836;
  41 static int ad1836_register(struct ad1836_priv *ad1836);
  42 static void ad1836_unregister(struct ad1836_priv *ad1836);
  43
  44 /*
  45  * AD1836 volume/mute/de-emphasis etc. controls
  46  */
  47 static const char *ad1836_deemp[] = {"None", "44.1kHz", "32kHz", "48kHz"};
  48
  49 static const struct soc_enum ad1836_deemp_enum =
  50         SOC_ENUM_SINGLE(AD1836_DAC_CTRL1, 8, 4, ad1836_deemp);
  51
  52 static const struct snd_kcontrol_new ad1836_snd_controls[] = {
  53         /* DAC volume control */
  54         SOC_DOUBLE_R("DAC1 Volume", AD1836_DAC_L1_VOL,
  55                         AD1836_DAC_R1_VOL, 0, 0x3FF, 0),
  56         SOC_DOUBLE_R("DAC2 Volume", AD1836_DAC_L2_VOL,
  57                         AD1836_DAC_R2_VOL, 0, 0x3FF, 0),
  58         SOC_DOUBLE_R("DAC3 Volume", AD1836_DAC_L3_VOL,
  59                         AD1836_DAC_R3_VOL, 0, 0x3FF, 0),
  60
  61         /* ADC switch control */
  62         SOC_DOUBLE("ADC1 Switch", AD1836_ADC_CTRL2, AD1836_ADCL1_MUTE,
  63                 AD1836_ADCR1_MUTE, 1, 1),
  64         SOC_DOUBLE("ADC2 Switch", AD1836_ADC_CTRL2, AD1836_ADCL2_MUTE,
  65                 AD1836_ADCR2_MUTE, 1, 1),
  66
  67         /* DAC switch control */
  68         SOC_DOUBLE("DAC1 Switch", AD1836_DAC_CTRL2, AD1836_DACL1_MUTE,
  69                 AD1836_DACR1_MUTE, 1, 1),
  70         SOC_DOUBLE("DAC2 Switch", AD1836_DAC_CTRL2, AD1836_DACL2_MUTE,
  71                 AD1836_DACR2_MUTE, 1, 1),
  72         SOC_DOUBLE("DAC3 Switch", AD1836_DAC_CTRL2, AD1836_DACL3_MUTE,
  73                 AD1836_DACR3_MUTE, 1, 1),
  74
  75         /* ADC high-pass filter */
  76         SOC_SINGLE("ADC High Pass Filter Switch", AD1836_ADC_CTRL1,
  77                         AD1836_ADC_HIGHPASS_FILTER, 1, 0),
  78
  79         /* DAC de-emphasis */
  80         SOC_ENUM("Playback Deemphasis", ad1836_deemp_enum),
  81 };
  82
  83 static const struct snd_soc_dapm_widget ad1836_dapm_widgets[] = {
  84         SND_SOC_DAPM_DAC("DAC", "Playback", AD1836_DAC_CTRL1,
  85                                 AD1836_DAC_POWERDOWN, 1),
  86         SND_SOC_DAPM_ADC("ADC", "Capture", SND_SOC_NOPM, 0, 0),
  87         SND_SOC_DAPM_SUPPLY("ADC_PWR", AD1836_ADC_CTRL1,
  88                                 AD1836_ADC_POWERDOWN, 1, NULL, 0),
  89         SND_SOC_DAPM_OUTPUT("DAC1OUT"),
  90         SND_SOC_DAPM_OUTPUT("DAC2OUT"),
  91         SND_SOC_DAPM_OUTPUT("DAC3OUT"),
  92         SND_SOC_DAPM_INPUT("ADC1IN"),
  93         SND_SOC_DAPM_INPUT("ADC2IN"),
  94 };
  95
  96 static const struct snd_soc_dapm_route audio_paths[] = {
  97         { "DAC", NULL, "ADC_PWR" },
  98         { "ADC", NULL, "ADC_PWR" },
  99         { "DAC1OUT", "DAC1 Switch", "DAC" },
 100         { "DAC2OUT", "DAC2 Switch", "DAC" },
 101         { "DAC3OUT", "DAC3 Switch", "DAC" },
 102         { "ADC", "ADC1 Switch", "ADC1IN" },
 103         { "ADC", "ADC2 Switch", "ADC2IN" },
 104 };
 105
 106 /*
 107  * DAI ops entries
 108  */
 109
 110 static int ad1836_set_dai_fmt(struct snd_soc_dai *codec_dai,
 111                 unsigned int fmt)
 112 {
 113         switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
 114         /* at present, we support adc aux mode to interface with
 115          * blackfin sport tdm mode
 116          */
 117         case SND_SOC_DAIFMT_DSP_A:
 118                 break;
 119         default:
 120                 return -EINVAL;
 121         }
 122
 123         switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
 124         case SND_SOC_DAIFMT_IB_IF:
 125                 break;
 126         default:
 127                 return -EINVAL;
 128         }
 129
 130         switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
 131         /* ALCLK,ABCLK are both output, AD1836 can only be master */
 132         case SND_SOC_DAIFMT_CBM_CFM:
 133                 break;
 134         default:
 135                 return -EINVAL;
 136         }
 137
 138         return 0;
 139 }
 140
 141 static int ad1836_hw_params(struct snd_pcm_substream *substream,
 142                 struct snd_pcm_hw_params *params,
 143                 struct snd_soc_dai *dai)
 144 {
 145         int word_len = 0;
 146
 147         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 148         struct snd_soc_device *socdev = rtd->socdev;
 149         struct snd_soc_codec *codec = socdev->card->codec;
 150
 151         /* bit size */
 152         switch (params_format(params)) {
 153         case SNDRV_PCM_FORMAT_S16_LE:
 154                 word_len = 3;
 155                 break;
 156         case SNDRV_PCM_FORMAT_S20_3LE:
 157                 word_len = 1;
 158                 break;
 159         case SNDRV_PCM_FORMAT_S24_LE:
 160         case SNDRV_PCM_FORMAT_S32_LE:
 161                 word_len = 0;
 162                 break;
 163         }
 164
 165         snd_soc_update_bits(codec, AD1836_DAC_CTRL1,
 166                 AD1836_DAC_WORD_LEN_MASK, word_len);
 167
 168         snd_soc_update_bits(codec, AD1836_ADC_CTRL2,
 169                 AD1836_ADC_WORD_LEN_MASK, word_len);
 170
 171         return 0;
 172 }
 173
 174
 175 /*
 176  * interface to read/write ad1836 register
 177  */
 178 #define AD1836_SPI_REG_SHFT 12
 179 #define AD1836_SPI_READ     (1 << 11)
 180 #define AD1836_SPI_VAL_MSK  0x3FF
 181
 182 /*
 183  * write to the ad1836 register space
 184  */
 185
 186 static int ad1836_write_reg(struct snd_soc_codec *codec, unsigned int reg,
 187                 unsigned int value)
 188 {
 189         u16 *reg_cache = codec->reg_cache;
 190         int ret = 0;
 191
 192         if (value != reg_cache[reg]) {
 193                 unsigned short buf;
 194                 struct spi_transfer t = {
 195                         .tx_buf = &buf,
 196                         .len = 2,
 197                 };
 198                 struct spi_message m;
 199
 200                 buf = (reg << AD1836_SPI_REG_SHFT) |
 201                         (value & AD1836_SPI_VAL_MSK);
 202                 spi_message_init(&m);
 203                 spi_message_add_tail(&t, &m);
 204                 ret = spi_sync(codec->control_data, &m);
 205                 if (ret == 0)
 206                         reg_cache[reg] = value;
 207         }
 208
 209         return ret;
 210 }
 211
 212 /*
 213  * read from the ad1836 register space cache
 214  */
 215 static unsigned int ad1836_read_reg_cache(struct snd_soc_codec *codec,
 216                                           unsigned int reg)
 217 {
 218         u16 *reg_cache = codec->reg_cache;
 219
 220         if (reg >= codec->reg_cache_size)
 221                 return -EINVAL;
 222
 223         return reg_cache[reg];
 224 }
 225
 226 #ifdef CONFIG_PM
 227 static int ad1836_soc_suspend(struct platform_device *pdev,
 228                 pm_message_t state)
 229 {
 230         struct snd_soc_device *socdev = platform_get_drvdata(pdev);
 231         struct snd_soc_codec *codec = socdev->card->codec;
 232
 233         /* reset clock control mode */
 234         u16 adc_ctrl2 =  codec->read(codec, AD1836_ADC_CTRL2);
 235         adc_ctrl2 &= ~AD1836_ADC_SERFMT_MASK;
 236
 237         return codec->write(codec, AD1836_ADC_CTRL2, adc_ctrl2);
 238 }
 239
 240 static int ad1836_soc_resume(struct platform_device *pdev)
 241 {
 242         struct snd_soc_device *socdev = platform_get_drvdata(pdev);
 243         struct snd_soc_codec *codec = socdev->card->codec;
 244
 245         /* restore clock control mode */
 246         u16 adc_ctrl2 = codec->read(codec, AD1836_ADC_CTRL2);
 247         adc_ctrl2 |= AD1836_ADC_AUX;
 248
 249         return codec->write(codec, AD1836_ADC_CTRL2, adc_ctrl2);
 250 }
 251 #else
 252 #define ad1836_soc_suspend NULL
 253 #define ad1836_soc_resume  NULL
 254 #endif
 255
 256 static int __devinit ad1836_spi_probe(struct spi_device *spi)
 257 {
 258         struct snd_soc_codec *codec;
 259         struct ad1836_priv *ad1836;
 260
 261         ad1836 = kzalloc(sizeof(struct ad1836_priv), GFP_KERNEL);
 262         if (ad1836 == NULL)
 263                 return -ENOMEM;
 264
 265         codec = &ad1836->codec;
 266         codec->control_data = spi;
 267         codec->dev = &spi->dev;
 268
 269         dev_set_drvdata(&spi->dev, ad1836);
 270
 271         return ad1836_register(ad1836);
 272 }
 273
 274 static int __devexit ad1836_spi_remove(struct spi_device *spi)
 275 {
 276         struct ad1836_priv *ad1836 = dev_get_drvdata(&spi->dev);
 277
 278         ad1836_unregister(ad1836);
 279         return 0;
 280 }
 281
 282 static struct spi_driver ad1836_spi_driver = {
 283         .driver = {
 284                 .name   = "ad1836",
 285                 .owner  = THIS_MODULE,
 286         },
 287         .probe          = ad1836_spi_probe,
 288         .remove         = __devexit_p(ad1836_spi_remove),
 289 };
 290
 291 static struct snd_soc_dai_ops ad1836_dai_ops = {
 292         .hw_params = ad1836_hw_params,
 293         .set_fmt = ad1836_set_dai_fmt,
 294 };
 295
 296 /* codec DAI instance */
 297 struct snd_soc_dai ad1836_dai = {
 298         .name = "AD1836",
 299         .playback = {
 300                 .stream_name = "Playback",
 301                 .channels_min = 2,
 302                 .channels_max = 6,
 303                 .rates = SNDRV_PCM_RATE_48000,
 304                 .formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
 305                         SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
 306         },
 307         .capture = {
 308                 .stream_name = "Capture",
 309                 .channels_min = 2,
 310                 .channels_max = 4,
 311                 .rates = SNDRV_PCM_RATE_48000,
 312                 .formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
 313                         SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
 314         },
 315         .ops = &ad1836_dai_ops,
 316 };
 317 EXPORT_SYMBOL_GPL(ad1836_dai);
 318
 319 static int ad1836_register(struct ad1836_priv *ad1836)
 320 {
 321         int ret;
 322         struct snd_soc_codec *codec = &ad1836->codec;
 323
 324         if (ad1836_codec) {
 325                 dev_err(codec->dev, "Another ad1836 is registered\n");
 326                 return -EINVAL;
 327         }
 328
 329         mutex_init(&codec->mutex);
 330         INIT_LIST_HEAD(&codec->dapm_widgets);
 331         INIT_LIST_HEAD(&codec->dapm_paths);
 332         codec->private_data = ad1836;
 333         codec->reg_cache = ad1836->reg_cache;
 334         codec->reg_cache_size = AD1836_NUM_REGS;
 335         codec->name = "AD1836";
 336         codec->owner = THIS_MODULE;
 337         codec->dai = &ad1836_dai;
 338         codec->num_dai = 1;
 339         codec->write = ad1836_write_reg;
 340         codec->read = ad1836_read_reg_cache;
 341         INIT_LIST_HEAD(&codec->dapm_widgets);
 342         INIT_LIST_HEAD(&codec->dapm_paths);
 343
 344         ad1836_dai.dev = codec->dev;
 345         ad1836_codec = codec;
 346
 347         /* default setting for ad1836 */
 348         /* de-emphasis: 48kHz, power-on dac */
 349         codec->write(codec, AD1836_DAC_CTRL1, 0x300);
 350         /* unmute dac channels */
 351         codec->write(codec, AD1836_DAC_CTRL2, 0x0);
 352         /* high-pass filter enable, power-on adc */
 353         codec->write(codec, AD1836_ADC_CTRL1, 0x100);
 354         /* unmute adc channles, adc aux mode */
 355         codec->write(codec, AD1836_ADC_CTRL2, 0x180);
 356         /* left/right diff:PGA/MUX */
 357         codec->write(codec, AD1836_ADC_CTRL3, 0x3A);
 358         /* volume */
 359         codec->write(codec, AD1836_DAC_L1_VOL, 0x3FF);
 360         codec->write(codec, AD1836_DAC_R1_VOL, 0x3FF);
 361         codec->write(codec, AD1836_DAC_L2_VOL, 0x3FF);
 362         codec->write(codec, AD1836_DAC_R2_VOL, 0x3FF);
 363         codec->write(codec, AD1836_DAC_L3_VOL, 0x3FF);
 364         codec->write(codec, AD1836_DAC_R3_VOL, 0x3FF);
 365
 366         ret = snd_soc_register_codec(codec);
 367         if (ret != 0) {
 368                 dev_err(codec->dev, "Failed to register codec: %d\n", ret);
 369                 kfree(ad1836);
 370                 return ret;
 371         }
 372
 373         ret = snd_soc_register_dai(&ad1836_dai);
 374         if (ret != 0) {
 375                 dev_err(codec->dev, "Failed to register DAI: %d\n", ret);
 376                 snd_soc_unregister_codec(codec);
 377                 kfree(ad1836);
 378                 return ret;
 379         }
 380
 381         return 0;
 382 }
 383
 384 static void ad1836_unregister(struct ad1836_priv *ad1836)
 385 {
 386         snd_soc_unregister_dai(&ad1836_dai);
 387         snd_soc_unregister_codec(&ad1836->codec);
 388         kfree(ad1836);
 389         ad1836_codec = NULL;
 390 }
 391
 392 static int ad1836_probe(struct platform_device *pdev)
 393 {
 394         struct snd_soc_device *socdev = platform_get_drvdata(pdev);
 395         struct snd_soc_codec *codec;
 396         int ret = 0;
 397
 398         if (ad1836_codec == NULL) {
 399                 dev_err(&pdev->dev, "Codec device not registered\n");
 400                 return -ENODEV;
 401         }
 402
 403         socdev->card->codec = ad1836_codec;
 404         codec = ad1836_codec;
 405
 406         /* register pcms */
 407         ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
 408         if (ret < 0) {
 409                 dev_err(codec->dev, "failed to create pcms: %d\n", ret);
 410                 goto pcm_err;
 411         }
 412
 413         snd_soc_add_controls(codec, ad1836_snd_controls,
 414                              ARRAY_SIZE(ad1836_snd_controls));
 415         snd_soc_dapm_new_controls(codec, ad1836_dapm_widgets,
 416                                   ARRAY_SIZE(ad1836_dapm_widgets));
 417         snd_soc_dapm_add_routes(codec, audio_paths, ARRAY_SIZE(audio_paths));
 418
 419 pcm_err:
 420         return ret;
 421 }
 422
 423 /* power down chip */
 424 static int ad1836_remove(struct platform_device *pdev)
 425 {
 426         struct snd_soc_device *socdev = platform_get_drvdata(pdev);
 427
 428         snd_soc_free_pcms(socdev);
 429         snd_soc_dapm_free(socdev);
 430
 431         return 0;
 432 }
 433
 434 struct snd_soc_codec_device soc_codec_dev_ad1836 = {
 435         .probe =        ad1836_probe,
 436         .remove =       ad1836_remove,
 437         .suspend =      ad1836_soc_suspend,
 438         .resume =       ad1836_soc_resume,
 439 };
 440 EXPORT_SYMBOL_GPL(soc_codec_dev_ad1836);
 441
 442 static int __init ad1836_init(void)
 443 {
 444         int ret;
 445
 446         ret = spi_register_driver(&ad1836_spi_driver);
 447         if (ret != 0) {
 448                 printk(KERN_ERR "Failed to register ad1836 SPI driver: %d\n",
 449                                 ret);
 450         }
 451
 452         return ret;
 453 }
 454 module_init(ad1836_init);
 455
 456 static void __exit ad1836_exit(void)
 457 {
 458         spi_unregister_driver(&ad1836_spi_driver);
 459 }
 460 module_exit(ad1836_exit);
 461
 462 MODULE_DESCRIPTION("ASoC ad1836 driver");
 463 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
 464 MODULE_LICENSE("GPL");