sound/soc/codecs/wm9705.c

   1 /*
   2  * wm9705.c  --  ALSA Soc WM9705 codec support
   3  *
   4  * Copyright 2008 Ian Molton <spyro@f2s.com>
   5  *
   6  *  This program is free software; you can redistribute  it and/or modify it
   7  *  under  the terms of  the GNU General  Public License as published by the
   8  *  Free Software Foundation; Version 2 of the  License only.
   9  *
  10  */
  11
  12 #include <linux/init.h>
  13 #include <linux/slab.h>
  14 #include <linux/module.h>
  15 #include <linux/kernel.h>
  16 #include <linux/device.h>
  17 #include <sound/core.h>
  18 #include <sound/pcm.h>
  19 #include <sound/ac97_codec.h>
  20 #include <sound/initval.h>
  21 #include <sound/soc.h>
  22 #include <sound/soc-dapm.h>
  23
  24 #include "wm9705.h"
  25
  26 /*
  27  * WM9705 register cache
  28  */
  29 static const u16 wm9705_reg[] = {
  30         0x6150, 0x8000, 0x8000, 0x8000, /* 0x0  */
  31         0x0000, 0x8000, 0x8008, 0x8008, /* 0x8  */
  32         0x8808, 0x8808, 0x8808, 0x8808, /* 0x10 */
  33         0x8808, 0x0000, 0x8000, 0x0000, /* 0x18 */
  34         0x0000, 0x0000, 0x0000, 0x000f, /* 0x20 */
  35         0x0605, 0x0000, 0xbb80, 0x0000, /* 0x28 */
  36         0x0000, 0xbb80, 0x0000, 0x0000, /* 0x30 */
  37         0x0000, 0x2000, 0x0000, 0x0000, /* 0x38 */
  38         0x0000, 0x0000, 0x0000, 0x0000, /* 0x40 */
  39         0x0000, 0x0000, 0x0000, 0x0000, /* 0x48 */
  40         0x0000, 0x0000, 0x0000, 0x0000, /* 0x50 */
  41         0x0000, 0x0000, 0x0000, 0x0000, /* 0x58 */
  42         0x0000, 0x0000, 0x0000, 0x0000, /* 0x60 */
  43         0x0000, 0x0000, 0x0000, 0x0000, /* 0x68 */
  44         0x0000, 0x0808, 0x0000, 0x0006, /* 0x70 */
  45         0x0000, 0x0000, 0x574d, 0x4c05, /* 0x78 */
  46 };
  47
  48 static const struct snd_kcontrol_new wm9705_snd_ac97_controls[] = {
  49         SOC_DOUBLE("Master Playback Volume", AC97_MASTER, 8, 0, 31, 1),
  50         SOC_SINGLE("Master Playback Switch", AC97_MASTER, 15, 1, 1),
  51         SOC_DOUBLE("Headphone Playback Volume", AC97_HEADPHONE, 8, 0, 31, 1),
  52         SOC_SINGLE("Headphone Playback Switch", AC97_HEADPHONE, 15, 1, 1),
  53         SOC_DOUBLE("PCM Playback Volume", AC97_PCM, 8, 0, 31, 1),
  54         SOC_SINGLE("PCM Playback Switch", AC97_PCM, 15, 1, 1),
  55         SOC_SINGLE("Mono Playback Volume", AC97_MASTER_MONO, 0, 31, 1),
  56         SOC_SINGLE("Mono Playback Switch", AC97_MASTER_MONO, 15, 1, 1),
  57         SOC_SINGLE("PCBeep Playback Volume", AC97_PC_BEEP, 1, 15, 1),
  58         SOC_SINGLE("Phone Playback Volume", AC97_PHONE, 0, 31, 1),
  59         SOC_DOUBLE("Line Playback Volume", AC97_LINE, 8, 0, 31, 1),
  60         SOC_DOUBLE("CD Playback Volume", AC97_CD, 8, 0, 31, 1),
  61         SOC_SINGLE("Mic Playback Volume", AC97_MIC, 0, 31, 1),
  62         SOC_SINGLE("Mic 20dB Boost Switch", AC97_MIC, 6, 1, 0),
  63         SOC_DOUBLE("Capture Volume", AC97_REC_GAIN, 8, 0, 15, 0),
  64         SOC_SINGLE("Capture Switch", AC97_REC_GAIN, 15, 1, 1),
  65 };
  66
  67 static const char *wm9705_mic[] = {"Mic 1", "Mic 2"};
  68 static const char *wm9705_rec_sel[] = {"Mic", "CD", "NC", "NC",
  69         "Line", "Stereo Mix", "Mono Mix", "Phone"};
  70
  71 static const struct soc_enum wm9705_enum_mic =
  72         SOC_ENUM_SINGLE(AC97_GENERAL_PURPOSE, 8, 2, wm9705_mic);
  73 static const struct soc_enum wm9705_enum_rec_l =
  74         SOC_ENUM_SINGLE(AC97_REC_SEL, 8, 8, wm9705_rec_sel);
  75 static const struct soc_enum wm9705_enum_rec_r =
  76         SOC_ENUM_SINGLE(AC97_REC_SEL, 0, 8, wm9705_rec_sel);
  77
  78 /* Headphone Mixer */
  79 static const struct snd_kcontrol_new wm9705_hp_mixer_controls[] = {
  80         SOC_DAPM_SINGLE("PCBeep Playback Switch", AC97_PC_BEEP, 15, 1, 1),
  81         SOC_DAPM_SINGLE("CD Playback Switch", AC97_CD, 15, 1, 1),
  82         SOC_DAPM_SINGLE("Mic Playback Switch", AC97_MIC, 15, 1, 1),
  83         SOC_DAPM_SINGLE("Phone Playback Switch", AC97_PHONE, 15, 1, 1),
  84         SOC_DAPM_SINGLE("Line Playback Switch", AC97_LINE, 15, 1, 1),
  85 };
  86
  87 /* Mic source */
  88 static const struct snd_kcontrol_new wm9705_mic_src_controls =
  89         SOC_DAPM_ENUM("Route", wm9705_enum_mic);
  90
  91 /* Capture source */
  92 static const struct snd_kcontrol_new wm9705_capture_selectl_controls =
  93         SOC_DAPM_ENUM("Route", wm9705_enum_rec_l);
  94 static const struct snd_kcontrol_new wm9705_capture_selectr_controls =
  95         SOC_DAPM_ENUM("Route", wm9705_enum_rec_r);
  96
  97 /* DAPM widgets */
  98 static const struct snd_soc_dapm_widget wm9705_dapm_widgets[] = {
  99         SND_SOC_DAPM_MUX("Mic Source", SND_SOC_NOPM, 0, 0,
 100                 &wm9705_mic_src_controls),
 101         SND_SOC_DAPM_MUX("Left Capture Source", SND_SOC_NOPM, 0, 0,
 102                 &wm9705_capture_selectl_controls),
 103         SND_SOC_DAPM_MUX("Right Capture Source", SND_SOC_NOPM, 0, 0,
 104                 &wm9705_capture_selectr_controls),
 105         SND_SOC_DAPM_DAC("Left DAC", "Left HiFi Playback",
 106                 SND_SOC_NOPM, 0, 0),
 107         SND_SOC_DAPM_DAC("Right DAC", "Right HiFi Playback",
 108                 SND_SOC_NOPM, 0, 0),
 109         SND_SOC_DAPM_MIXER_NAMED_CTL("HP Mixer", SND_SOC_NOPM, 0, 0,
 110                 &wm9705_hp_mixer_controls[0],
 111                 ARRAY_SIZE(wm9705_hp_mixer_controls)),
 112         SND_SOC_DAPM_MIXER("Mono Mixer", SND_SOC_NOPM, 0, 0, NULL, 0),
 113         SND_SOC_DAPM_ADC("Left ADC", "Left HiFi Capture", SND_SOC_NOPM, 0, 0),
 114         SND_SOC_DAPM_ADC("Right ADC", "Right HiFi Capture", SND_SOC_NOPM, 0, 0),
 115         SND_SOC_DAPM_PGA("Headphone PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
 116         SND_SOC_DAPM_PGA("Speaker PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
 117         SND_SOC_DAPM_PGA("Line PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
 118         SND_SOC_DAPM_PGA("Line out PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
 119         SND_SOC_DAPM_PGA("Mono PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
 120         SND_SOC_DAPM_PGA("Phone PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
 121         SND_SOC_DAPM_PGA("Mic PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
 122         SND_SOC_DAPM_PGA("PCBEEP PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
 123         SND_SOC_DAPM_PGA("CD PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
 124         SND_SOC_DAPM_PGA("ADC PGA", SND_SOC_NOPM, 0, 0, NULL, 0),
 125         SND_SOC_DAPM_OUTPUT("HPOUTL"),
 126         SND_SOC_DAPM_OUTPUT("HPOUTR"),
 127         SND_SOC_DAPM_OUTPUT("LOUT"),
 128         SND_SOC_DAPM_OUTPUT("ROUT"),
 129         SND_SOC_DAPM_OUTPUT("MONOOUT"),
 130         SND_SOC_DAPM_INPUT("PHONE"),
 131         SND_SOC_DAPM_INPUT("LINEINL"),
 132         SND_SOC_DAPM_INPUT("LINEINR"),
 133         SND_SOC_DAPM_INPUT("CDINL"),
 134         SND_SOC_DAPM_INPUT("CDINR"),
 135         SND_SOC_DAPM_INPUT("PCBEEP"),
 136         SND_SOC_DAPM_INPUT("MIC1"),
 137         SND_SOC_DAPM_INPUT("MIC2"),
 138 };
 139
 140 /* Audio map
 141  * WM9705 has no switches to disable the route from the inputs to the HP mixer
 142  * so in order to prevent active inputs from forcing the audio outputs to be
 143  * constantly enabled, we use the mutes on those inputs to simulate such
 144  * controls.
 145  */
 146 static const struct snd_soc_dapm_route audio_map[] = {
 147         /* HP mixer */
 148         {"HP Mixer", "PCBeep Playback Switch", "PCBEEP PGA"},
 149         {"HP Mixer", "CD Playback Switch", "CD PGA"},
 150         {"HP Mixer", "Mic Playback Switch", "Mic PGA"},
 151         {"HP Mixer", "Phone Playback Switch", "Phone PGA"},
 152         {"HP Mixer", "Line Playback Switch", "Line PGA"},
 153         {"HP Mixer", NULL, "Left DAC"},
 154         {"HP Mixer", NULL, "Right DAC"},
 155
 156         /* mono mixer */
 157         {"Mono Mixer", NULL, "HP Mixer"},
 158
 159         /* outputs */
 160         {"Headphone PGA", NULL, "HP Mixer"},
 161         {"HPOUTL", NULL, "Headphone PGA"},
 162         {"HPOUTR", NULL, "Headphone PGA"},
 163         {"Line out PGA", NULL, "HP Mixer"},
 164         {"LOUT", NULL, "Line out PGA"},
 165         {"ROUT", NULL, "Line out PGA"},
 166         {"Mono PGA", NULL, "Mono Mixer"},
 167         {"MONOOUT", NULL, "Mono PGA"},
 168
 169         /* inputs */
 170         {"CD PGA", NULL, "CDINL"},
 171         {"CD PGA", NULL, "CDINR"},
 172         {"Line PGA", NULL, "LINEINL"},
 173         {"Line PGA", NULL, "LINEINR"},
 174         {"Phone PGA", NULL, "PHONE"},
 175         {"Mic Source", "Mic 1", "MIC1"},
 176         {"Mic Source", "Mic 2", "MIC2"},
 177         {"Mic PGA", NULL, "Mic Source"},
 178         {"PCBEEP PGA", NULL, "PCBEEP"},
 179
 180         /* Left capture selector */
 181         {"Left Capture Source", "Mic", "Mic Source"},
 182         {"Left Capture Source", "CD", "CDINL"},
 183         {"Left Capture Source", "Line", "LINEINL"},
 184         {"Left Capture Source", "Stereo Mix", "HP Mixer"},
 185         {"Left Capture Source", "Mono Mix", "HP Mixer"},
 186         {"Left Capture Source", "Phone", "PHONE"},
 187
 188         /* Right capture source */
 189         {"Right Capture Source", "Mic", "Mic Source"},
 190         {"Right Capture Source", "CD", "CDINR"},
 191         {"Right Capture Source", "Line", "LINEINR"},
 192         {"Right Capture Source", "Stereo Mix", "HP Mixer"},
 193         {"Right Capture Source", "Mono Mix", "HP Mixer"},
 194         {"Right Capture Source", "Phone", "PHONE"},
 195
 196         {"ADC PGA", NULL, "Left Capture Source"},
 197         {"ADC PGA", NULL, "Right Capture Source"},
 198
 199         /* ADC's */
 200         {"Left ADC",  NULL, "ADC PGA"},
 201         {"Right ADC", NULL, "ADC PGA"},
 202 };
 203
 204 static int wm9705_add_widgets(struct snd_soc_codec *codec)
 205 {
 206         snd_soc_dapm_new_controls(codec, wm9705_dapm_widgets,
 207                                         ARRAY_SIZE(wm9705_dapm_widgets));
 208         snd_soc_dapm_add_routes(codec, audio_map, ARRAY_SIZE(audio_map));
 209
 210         return 0;
 211 }
 212
 213 /* We use a register cache to enhance read performance. */
 214 static unsigned int ac97_read(struct snd_soc_codec *codec, unsigned int reg)
 215 {
 216         u16 *cache = codec->reg_cache;
 217
 218         switch (reg) {
 219         case AC97_RESET:
 220         case AC97_VENDOR_ID1:
 221         case AC97_VENDOR_ID2:
 222                 return soc_ac97_ops.read(codec->ac97, reg);
 223         default:
 224                 reg = reg >> 1;
 225
 226                 if (reg >= (ARRAY_SIZE(wm9705_reg)))
 227                         return -EIO;
 228
 229                 return cache[reg];
 230         }
 231 }
 232
 233 static int ac97_write(struct snd_soc_codec *codec, unsigned int reg,
 234         unsigned int val)
 235 {
 236         u16 *cache = codec->reg_cache;
 237
 238         soc_ac97_ops.write(codec->ac97, reg, val);
 239         reg = reg >> 1;
 240         if (reg < (ARRAY_SIZE(wm9705_reg)))
 241                 cache[reg] = val;
 242
 243         return 0;
 244 }
 245
 246 static int ac97_prepare(struct snd_pcm_substream *substream,
 247                         struct snd_soc_dai *dai)
 248 {
 249         struct snd_pcm_runtime *runtime = substream->runtime;
 250         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 251         struct snd_soc_device *socdev = rtd->socdev;
 252         struct snd_soc_codec *codec = socdev->card->codec;
 253         int reg;
 254         u16 vra;
 255
 256         vra = ac97_read(codec, AC97_EXTENDED_STATUS);
 257         ac97_write(codec, AC97_EXTENDED_STATUS, vra | 0x1);
 258
 259         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
 260                 reg = AC97_PCM_FRONT_DAC_RATE;
 261         else
 262                 reg = AC97_PCM_LR_ADC_RATE;
 263
 264         return ac97_write(codec, reg, runtime->rate);
 265 }
 266
 267 #define WM9705_AC97_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 | \
 268                         SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 | \
 269                         SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
 270                         SNDRV_PCM_RATE_48000)
 271
 272 static struct snd_soc_dai_ops wm9705_dai_ops = {
 273         .prepare        = ac97_prepare,
 274 };
 275
 276 struct snd_soc_dai wm9705_dai[] = {
 277         {
 278                 .name = "AC97 HiFi",
 279                 .ac97_control = 1,
 280                 .playback = {
 281                         .stream_name = "HiFi Playback",
 282                         .channels_min = 1,
 283                         .channels_max = 2,
 284                         .rates = WM9705_AC97_RATES,
 285                         .formats = SND_SOC_STD_AC97_FMTS,
 286                 },
 287                 .capture = {
 288                         .stream_name = "HiFi Capture",
 289                         .channels_min = 1,
 290                         .channels_max = 2,
 291                         .rates = WM9705_AC97_RATES,
 292                         .formats = SND_SOC_STD_AC97_FMTS,
 293                 },
 294                 .ops = &wm9705_dai_ops,
 295         },
 296         {
 297                 .name = "AC97 Aux",
 298                 .playback = {
 299                         .stream_name = "Aux Playback",
 300                         .channels_min = 1,
 301                         .channels_max = 1,
 302                         .rates = WM9705_AC97_RATES,
 303                         .formats = SNDRV_PCM_FMTBIT_S16_LE,
 304                 },
 305         }
 306 };
 307 EXPORT_SYMBOL_GPL(wm9705_dai);
 308
 309 static int wm9705_reset(struct snd_soc_codec *codec)
 310 {
 311         if (soc_ac97_ops.reset) {
 312                 soc_ac97_ops.reset(codec->ac97);
 313                 if (ac97_read(codec, 0) == wm9705_reg[0])
 314                         return 0; /* Success */
 315         }
 316
 317         return -EIO;
 318 }
 319
 320 #ifdef CONFIG_PM
 321 static int wm9705_soc_suspend(struct platform_device *pdev, pm_message_t msg)
 322 {
 323         struct snd_soc_device *socdev = platform_get_drvdata(pdev);
 324         struct snd_soc_codec *codec = socdev->card->codec;
 325
 326         soc_ac97_ops.write(codec->ac97, AC97_POWERDOWN, 0xffff);
 327
 328         return 0;
 329 }
 330
 331 static int wm9705_soc_resume(struct platform_device *pdev)
 332 {
 333         struct snd_soc_device *socdev = platform_get_drvdata(pdev);
 334         struct snd_soc_codec *codec = socdev->card->codec;
 335         int i, ret;
 336         u16 *cache = codec->reg_cache;
 337
 338         ret = wm9705_reset(codec);
 339         if (ret < 0) {
 340                 printk(KERN_ERR "could not reset AC97 codec\n");
 341                 return ret;
 342         }
 343
 344         for (i = 2; i < ARRAY_SIZE(wm9705_reg) << 1; i += 2) {
 345                 soc_ac97_ops.write(codec->ac97, i, cache[i>>1]);
 346         }
 347
 348         return 0;
 349 }
 350 #else
 351 #define wm9705_soc_suspend NULL
 352 #define wm9705_soc_resume NULL
 353 #endif
 354
 355 static int wm9705_soc_probe(struct platform_device *pdev)
 356 {
 357         struct snd_soc_device *socdev = platform_get_drvdata(pdev);
 358         struct snd_soc_codec *codec;
 359         int ret = 0;
 360
 361         printk(KERN_INFO "WM9705 SoC Audio Codec\n");
 362
 363         socdev->card->codec = kzalloc(sizeof(struct snd_soc_codec),
 364                                       GFP_KERNEL);
 365         if (socdev->card->codec == NULL)
 366                 return -ENOMEM;
 367         codec = socdev->card->codec;
 368         mutex_init(&codec->mutex);
 369
 370         codec->reg_cache = kmemdup(wm9705_reg, sizeof(wm9705_reg), GFP_KERNEL);
 371         if (codec->reg_cache == NULL) {
 372                 ret = -ENOMEM;
 373                 goto cache_err;
 374         }
 375         codec->reg_cache_size = sizeof(wm9705_reg);
 376         codec->reg_cache_step = 2;
 377
 378         codec->name = "WM9705";
 379         codec->owner = THIS_MODULE;
 380         codec->dai = wm9705_dai;
 381         codec->num_dai = ARRAY_SIZE(wm9705_dai);
 382         codec->write = ac97_write;
 383         codec->read = ac97_read;
 384         INIT_LIST_HEAD(&codec->dapm_widgets);
 385         INIT_LIST_HEAD(&codec->dapm_paths);
 386
 387         ret = snd_soc_new_ac97_codec(codec, &soc_ac97_ops, 0);
 388         if (ret < 0) {
 389                 printk(KERN_ERR "wm9705: failed to register AC97 codec\n");
 390                 goto codec_err;
 391         }
 392
 393         /* register pcms */
 394         ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
 395         if (ret < 0)
 396                 goto pcm_err;
 397
 398         ret = wm9705_reset(codec);
 399         if (ret)
 400                 goto reset_err;
 401
 402         snd_soc_add_controls(codec, wm9705_snd_ac97_controls,
 403                                 ARRAY_SIZE(wm9705_snd_ac97_controls));
 404         wm9705_add_widgets(codec);
 405
 406         return 0;
 407
 408 reset_err:
 409         snd_soc_free_pcms(socdev);
 410 pcm_err:
 411         snd_soc_free_ac97_codec(codec);
 412 codec_err:
 413         kfree(codec->reg_cache);
 414 cache_err:
 415         kfree(socdev->card->codec);
 416         socdev->card->codec = NULL;
 417         return ret;
 418 }
 419
 420 static int wm9705_soc_remove(struct platform_device *pdev)
 421 {
 422         struct snd_soc_device *socdev = platform_get_drvdata(pdev);
 423         struct snd_soc_codec *codec = socdev->card->codec;
 424
 425         if (codec == NULL)
 426                 return 0;
 427
 428         snd_soc_dapm_free(socdev);
 429         snd_soc_free_pcms(socdev);
 430         snd_soc_free_ac97_codec(codec);
 431         kfree(codec->reg_cache);
 432         kfree(codec);
 433         return 0;
 434 }
 435
 436 struct snd_soc_codec_device soc_codec_dev_wm9705 = {
 437         .probe =        wm9705_soc_probe,
 438         .remove =       wm9705_soc_remove,
 439         .suspend =      wm9705_soc_suspend,
 440         .resume =       wm9705_soc_resume,
 441 };
 442 EXPORT_SYMBOL_GPL(soc_codec_dev_wm9705);
 443
 444 MODULE_DESCRIPTION("ASoC WM9705 driver");
 445 MODULE_AUTHOR("Ian Molton");
 446 MODULE_LICENSE("GPL v2");