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