sound/soc/codecs/stac9766.c

   1 /*
   2  * stac9766.c  --  ALSA SoC STAC9766 codec support
   3  *
   4  * Copyright 2009 Jon Smirl, Digispeaker
   5  * Author: Jon Smirl <jonsmirl@gmail.com>
   6  *
   7  *  This program is free software; you can redistribute  it and/or modify it
   8  *  under  the terms of  the GNU General  Public License as published by the
   9  *  Free Software Foundation;  either version 2 of the  License, or (at your
  10  *  option) any later version.
  11  *
  12  *  Features:-
  13  *
  14  *   o Support for AC97 Codec, S/PDIF
  15  */
  16
  17 #include <linux/init.h>
  18 #include <linux/slab.h>
  19 #include <linux/module.h>
  20 #include <linux/device.h>
  21 #include <sound/core.h>
  22 #include <sound/pcm.h>
  23 #include <sound/ac97_codec.h>
  24 #include <sound/initval.h>
  25 #include <sound/pcm_params.h>
  26 #include <sound/soc.h>
  27 #include <sound/tlv.h>
  28
  29 #include "stac9766.h"
  30
  31 /*
  32  * STAC9766 register cache
  33  */
  34 static const u16 stac9766_reg[] = {
  35         0x6A90, 0x8000, 0x8000, 0x8000, /* 6 */
  36         0x0000, 0x0000, 0x8008, 0x8008, /* e */
  37         0x8808, 0x8808, 0x8808, 0x8808, /* 16 */
  38         0x8808, 0x0000, 0x8000, 0x0000, /* 1e */
  39         0x0000, 0x0000, 0x0000, 0x000f, /* 26 */
  40         0x0a05, 0x0400, 0xbb80, 0x0000, /* 2e */
  41         0x0000, 0xbb80, 0x0000, 0x0000, /* 36 */
  42         0x0000, 0x2000, 0x0000, 0x0100, /* 3e */
  43         0x0000, 0x0000, 0x0080, 0x0000, /* 46 */
  44         0x0000, 0x0000, 0x0003, 0xffff, /* 4e */
  45         0x0000, 0x0000, 0x0000, 0x0000, /* 56 */
  46         0x4000, 0x0000, 0x0000, 0x0000, /* 5e */
  47         0x1201, 0xFFFF, 0xFFFF, 0x0000, /* 66 */
  48         0x0000, 0x0000, 0x0000, 0x0000, /* 6e */
  49         0x0000, 0x0000, 0x0000, 0x0006, /* 76 */
  50         0x0000, 0x0000, 0x0000, 0x0000, /* 7e */
  51 };
  52
  53 static const char *stac9766_record_mux[] = {"Mic", "CD", "Video", "AUX",
  54                         "Line", "Stereo Mix", "Mono Mix", "Phone"};
  55 static const char *stac9766_mono_mux[] = {"Mix", "Mic"};
  56 static const char *stac9766_mic_mux[] = {"Mic1", "Mic2"};
  57 static const char *stac9766_SPDIF_mux[] = {"PCM", "ADC Record"};
  58 static const char *stac9766_popbypass_mux[] = {"Normal", "Bypass Mixer"};
  59 static const char *stac9766_record_all_mux[] = {"All analog",
  60         "Analog plus DAC"};
  61 static const char *stac9766_boost1[] = {"0dB", "10dB"};
  62 static const char *stac9766_boost2[] = {"0dB", "20dB"};
  63 static const char *stac9766_stereo_mic[] = {"Off", "On"};
  64
  65 static SOC_ENUM_DOUBLE_DECL(stac9766_record_enum,
  66                             AC97_REC_SEL, 8, 0, stac9766_record_mux);
  67 static SOC_ENUM_SINGLE_DECL(stac9766_mono_enum,
  68                             AC97_GENERAL_PURPOSE, 9, stac9766_mono_mux);
  69 static SOC_ENUM_SINGLE_DECL(stac9766_mic_enum,
  70                             AC97_GENERAL_PURPOSE, 8, stac9766_mic_mux);
  71 static SOC_ENUM_SINGLE_DECL(stac9766_SPDIF_enum,
  72                             AC97_STAC_DA_CONTROL, 1, stac9766_SPDIF_mux);
  73 static SOC_ENUM_SINGLE_DECL(stac9766_popbypass_enum,
  74                             AC97_GENERAL_PURPOSE, 15, stac9766_popbypass_mux);
  75 static SOC_ENUM_SINGLE_DECL(stac9766_record_all_enum,
  76                             AC97_STAC_ANALOG_SPECIAL, 12,
  77                             stac9766_record_all_mux);
  78 static SOC_ENUM_SINGLE_DECL(stac9766_boost1_enum,
  79                             AC97_MIC, 6, stac9766_boost1); /* 0/10dB */
  80 static SOC_ENUM_SINGLE_DECL(stac9766_boost2_enum,
  81                             AC97_STAC_ANALOG_SPECIAL, 2, stac9766_boost2); /* 0/20dB */
  82 static SOC_ENUM_SINGLE_DECL(stac9766_stereo_mic_enum,
  83                             AC97_STAC_STEREO_MIC, 2, stac9766_stereo_mic);
  84
  85 static const DECLARE_TLV_DB_LINEAR(master_tlv, -4600, 0);
  86 static const DECLARE_TLV_DB_LINEAR(record_tlv, 0, 2250);
  87 static const DECLARE_TLV_DB_LINEAR(beep_tlv, -4500, 0);
  88 static const DECLARE_TLV_DB_LINEAR(mix_tlv, -3450, 1200);
  89
  90 static const struct snd_kcontrol_new stac9766_snd_ac97_controls[] = {
  91         SOC_DOUBLE_TLV("Speaker Volume", AC97_MASTER, 8, 0, 31, 1, master_tlv),
  92         SOC_SINGLE("Speaker Switch", AC97_MASTER, 15, 1, 1),
  93         SOC_DOUBLE_TLV("Headphone Volume", AC97_HEADPHONE, 8, 0, 31, 1,
  94                        master_tlv),
  95         SOC_SINGLE("Headphone Switch", AC97_HEADPHONE, 15, 1, 1),
  96         SOC_SINGLE_TLV("Mono Out Volume", AC97_MASTER_MONO, 0, 31, 1,
  97                        master_tlv),
  98         SOC_SINGLE("Mono Out Switch", AC97_MASTER_MONO, 15, 1, 1),
  99
 100         SOC_DOUBLE_TLV("Record Volume", AC97_REC_GAIN, 8, 0, 15, 0, record_tlv),
 101         SOC_SINGLE("Record Switch", AC97_REC_GAIN, 15, 1, 1),
 102
 103
 104         SOC_SINGLE_TLV("Beep Volume", AC97_PC_BEEP, 1, 15, 1, beep_tlv),
 105         SOC_SINGLE("Beep Switch", AC97_PC_BEEP, 15, 1, 1),
 106         SOC_SINGLE("Beep Frequency", AC97_PC_BEEP, 5, 127, 1),
 107         SOC_SINGLE_TLV("Phone Volume", AC97_PHONE, 0, 31, 1, mix_tlv),
 108         SOC_SINGLE("Phone Switch", AC97_PHONE, 15, 1, 1),
 109
 110         SOC_ENUM("Mic Boost1", stac9766_boost1_enum),
 111         SOC_ENUM("Mic Boost2", stac9766_boost2_enum),
 112         SOC_SINGLE_TLV("Mic Volume", AC97_MIC, 0, 31, 1, mix_tlv),
 113         SOC_SINGLE("Mic Switch", AC97_MIC, 15, 1, 1),
 114         SOC_ENUM("Stereo Mic", stac9766_stereo_mic_enum),
 115
 116         SOC_DOUBLE_TLV("Line Volume", AC97_LINE, 8, 0, 31, 1, mix_tlv),
 117         SOC_SINGLE("Line Switch", AC97_LINE, 15, 1, 1),
 118         SOC_DOUBLE_TLV("CD Volume", AC97_CD, 8, 0, 31, 1, mix_tlv),
 119         SOC_SINGLE("CD Switch", AC97_CD, 15, 1, 1),
 120         SOC_DOUBLE_TLV("AUX Volume", AC97_AUX, 8, 0, 31, 1, mix_tlv),
 121         SOC_SINGLE("AUX Switch", AC97_AUX, 15, 1, 1),
 122         SOC_DOUBLE_TLV("Video Volume", AC97_VIDEO, 8, 0, 31, 1, mix_tlv),
 123         SOC_SINGLE("Video Switch", AC97_VIDEO, 15, 1, 1),
 124
 125         SOC_DOUBLE_TLV("DAC Volume", AC97_PCM, 8, 0, 31, 1, mix_tlv),
 126         SOC_SINGLE("DAC Switch", AC97_PCM, 15, 1, 1),
 127         SOC_SINGLE("Loopback Test Switch", AC97_GENERAL_PURPOSE, 7, 1, 0),
 128         SOC_SINGLE("3D Volume", AC97_3D_CONTROL, 3, 2, 1),
 129         SOC_SINGLE("3D Switch", AC97_GENERAL_PURPOSE, 13, 1, 0),
 130
 131         SOC_ENUM("SPDIF Mux", stac9766_SPDIF_enum),
 132         SOC_ENUM("Mic1/2 Mux", stac9766_mic_enum),
 133         SOC_ENUM("Record All Mux", stac9766_record_all_enum),
 134         SOC_ENUM("Record Mux", stac9766_record_enum),
 135         SOC_ENUM("Mono Mux", stac9766_mono_enum),
 136         SOC_ENUM("Pop Bypass Mux", stac9766_popbypass_enum),
 137 };
 138
 139 static int stac9766_ac97_write(struct snd_soc_codec *codec, unsigned int reg,
 140                                unsigned int val)
 141 {
 142         struct snd_ac97 *ac97 = snd_soc_codec_get_drvdata(codec);
 143         u16 *cache = codec->reg_cache;
 144
 145         if (reg > AC97_STAC_PAGE0) {
 146                 stac9766_ac97_write(codec, AC97_INT_PAGING, 0);
 147                 soc_ac97_ops->write(ac97, reg, val);
 148                 stac9766_ac97_write(codec, AC97_INT_PAGING, 1);
 149                 return 0;
 150         }
 151         if (reg / 2 >= ARRAY_SIZE(stac9766_reg))
 152                 return -EIO;
 153
 154         soc_ac97_ops->write(ac97, reg, val);
 155         cache[reg / 2] = val;
 156         return 0;
 157 }
 158
 159 static unsigned int stac9766_ac97_read(struct snd_soc_codec *codec,
 160                                        unsigned int reg)
 161 {
 162         struct snd_ac97 *ac97 = snd_soc_codec_get_drvdata(codec);
 163         u16 val = 0, *cache = codec->reg_cache;
 164
 165         if (reg > AC97_STAC_PAGE0) {
 166                 stac9766_ac97_write(codec, AC97_INT_PAGING, 0);
 167                 val = soc_ac97_ops->read(ac97, reg - AC97_STAC_PAGE0);
 168                 stac9766_ac97_write(codec, AC97_INT_PAGING, 1);
 169                 return val;
 170         }
 171         if (reg / 2 >= ARRAY_SIZE(stac9766_reg))
 172                 return -EIO;
 173
 174         if (reg == AC97_RESET || reg == AC97_GPIO_STATUS ||
 175                 reg == AC97_INT_PAGING || reg == AC97_VENDOR_ID1 ||
 176                 reg == AC97_VENDOR_ID2) {
 177
 178                 val = soc_ac97_ops->read(ac97, reg);
 179                 return val;
 180         }
 181         return cache[reg / 2];
 182 }
 183
 184 static int ac97_analog_prepare(struct snd_pcm_substream *substream,
 185                                struct snd_soc_dai *dai)
 186 {
 187         struct snd_soc_codec *codec = dai->codec;
 188         struct snd_pcm_runtime *runtime = substream->runtime;
 189         unsigned short reg, vra;
 190
 191         vra = stac9766_ac97_read(codec, AC97_EXTENDED_STATUS);
 192
 193         vra |= 0x1; /* enable variable rate audio */
 194         vra &= ~0x4; /* disable SPDIF output */
 195
 196         stac9766_ac97_write(codec, AC97_EXTENDED_STATUS, vra);
 197
 198         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
 199                 reg = AC97_PCM_FRONT_DAC_RATE;
 200         else
 201                 reg = AC97_PCM_LR_ADC_RATE;
 202
 203         return stac9766_ac97_write(codec, reg, runtime->rate);
 204 }
 205
 206 static int ac97_digital_prepare(struct snd_pcm_substream *substream,
 207                                 struct snd_soc_dai *dai)
 208 {
 209         struct snd_soc_codec *codec = dai->codec;
 210         struct snd_pcm_runtime *runtime = substream->runtime;
 211         unsigned short reg, vra;
 212
 213         stac9766_ac97_write(codec, AC97_SPDIF, 0x2002);
 214
 215         vra = stac9766_ac97_read(codec, AC97_EXTENDED_STATUS);
 216         vra |= 0x5; /* Enable VRA and SPDIF out */
 217
 218         stac9766_ac97_write(codec, AC97_EXTENDED_STATUS, vra);
 219
 220         reg = AC97_PCM_FRONT_DAC_RATE;
 221
 222         return stac9766_ac97_write(codec, reg, runtime->rate);
 223 }
 224
 225 static int stac9766_set_bias_level(struct snd_soc_codec *codec,
 226                                    enum snd_soc_bias_level level)
 227 {
 228         switch (level) {
 229         case SND_SOC_BIAS_ON: /* full On */
 230         case SND_SOC_BIAS_PREPARE: /* partial On */
 231         case SND_SOC_BIAS_STANDBY: /* Off, with power */
 232                 stac9766_ac97_write(codec, AC97_POWERDOWN, 0x0000);
 233                 break;
 234         case SND_SOC_BIAS_OFF: /* Off, without power */
 235                 /* disable everything including AC link */
 236                 stac9766_ac97_write(codec, AC97_POWERDOWN, 0xffff);
 237                 break;
 238         }
 239         return 0;
 240 }
 241
 242 static int stac9766_reset(struct snd_soc_codec *codec, int try_warm)
 243 {
 244         struct snd_ac97 *ac97 = snd_soc_codec_get_drvdata(codec);
 245
 246         if (try_warm && soc_ac97_ops->warm_reset) {
 247                 soc_ac97_ops->warm_reset(ac97);
 248                 if (stac9766_ac97_read(codec, 0) == stac9766_reg[0])
 249                         return 1;
 250         }
 251
 252         soc_ac97_ops->reset(ac97);
 253         if (soc_ac97_ops->warm_reset)
 254                 soc_ac97_ops->warm_reset(ac97);
 255         if (stac9766_ac97_read(codec, 0) != stac9766_reg[0])
 256                 return -EIO;
 257         return 0;
 258 }
 259
 260 static int stac9766_codec_resume(struct snd_soc_codec *codec)
 261 {
 262         struct snd_ac97 *ac97 = snd_soc_codec_get_drvdata(codec);
 263         u16 id, reset;
 264
 265         reset = 0;
 266         /* give the codec an AC97 warm reset to start the link */
 267 reset:
 268         if (reset > 5) {
 269                 dev_err(codec->dev, "Failed to resume\n");
 270                 return -EIO;
 271         }
 272         ac97->bus->ops->warm_reset(ac97);
 273         id = soc_ac97_ops->read(ac97, AC97_VENDOR_ID2);
 274         if (id != 0x4c13) {
 275                 stac9766_reset(codec, 0);
 276                 reset++;
 277                 goto reset;
 278         }
 279
 280         return 0;
 281 }
 282
 283 static const struct snd_soc_dai_ops stac9766_dai_ops_analog = {
 284         .prepare = ac97_analog_prepare,
 285 };
 286
 287 static const struct snd_soc_dai_ops stac9766_dai_ops_digital = {
 288         .prepare = ac97_digital_prepare,
 289 };
 290
 291 static struct snd_soc_dai_driver stac9766_dai[] = {
 292 {
 293         .name = "stac9766-hifi-analog",
 294
 295         /* stream cababilities */
 296         .playback = {
 297                 .stream_name = "stac9766 analog",
 298                 .channels_min = 1,
 299                 .channels_max = 2,
 300                 .rates = SNDRV_PCM_RATE_8000_48000,
 301                 .formats = SND_SOC_STD_AC97_FMTS,
 302         },
 303         .capture = {
 304                 .stream_name = "stac9766 analog",
 305                 .channels_min = 1,
 306                 .channels_max = 2,
 307                 .rates = SNDRV_PCM_RATE_8000_48000,
 308                 .formats = SND_SOC_STD_AC97_FMTS,
 309         },
 310         /* alsa ops */
 311         .ops = &stac9766_dai_ops_analog,
 312 },
 313 {
 314         .name = "stac9766-hifi-IEC958",
 315
 316         /* stream cababilities */
 317         .playback = {
 318                 .stream_name = "stac9766 IEC958",
 319                 .channels_min = 1,
 320                 .channels_max = 2,
 321                 .rates = SNDRV_PCM_RATE_32000 | \
 322                         SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000,
 323                 .formats = SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE,
 324         },
 325         /* alsa ops */
 326         .ops = &stac9766_dai_ops_digital,
 327 }
 328 };
 329
 330 static int stac9766_codec_probe(struct snd_soc_codec *codec)
 331 {
 332         struct snd_ac97 *ac97;
 333         int ret = 0;
 334
 335         ac97 = snd_soc_new_ac97_codec(codec);
 336         if (IS_ERR(ac97))
 337                 return PTR_ERR(ac97);
 338
 339         snd_soc_codec_set_drvdata(codec, ac97);
 340
 341         /* do a cold reset for the controller and then try
 342          * a warm reset followed by an optional cold reset for codec */
 343         stac9766_reset(codec, 0);
 344         ret = stac9766_reset(codec, 1);
 345         if (ret < 0) {
 346                 dev_err(codec->dev, "Failed to reset: AC97 link error\n");
 347                 goto codec_err;
 348         }
 349
 350         return 0;
 351
 352 codec_err:
 353         snd_soc_free_ac97_codec(ac97);
 354         return ret;
 355 }
 356
 357 static int stac9766_codec_remove(struct snd_soc_codec *codec)
 358 {
 359         struct snd_ac97 *ac97 = snd_soc_codec_get_drvdata(codec);
 360
 361         snd_soc_free_ac97_codec(ac97);
 362         return 0;
 363 }
 364
 365 static struct snd_soc_codec_driver soc_codec_dev_stac9766 = {
 366         .controls = stac9766_snd_ac97_controls,
 367         .num_controls = ARRAY_SIZE(stac9766_snd_ac97_controls),
 368         .write = stac9766_ac97_write,
 369         .read = stac9766_ac97_read,
 370         .set_bias_level = stac9766_set_bias_level,
 371         .suspend_bias_off = true,
 372         .probe = stac9766_codec_probe,
 373         .remove = stac9766_codec_remove,
 374         .resume = stac9766_codec_resume,
 375         .reg_cache_size = ARRAY_SIZE(stac9766_reg),
 376         .reg_word_size = sizeof(u16),
 377         .reg_cache_step = 2,
 378         .reg_cache_default = stac9766_reg,
 379 };
 380
 381 static int stac9766_probe(struct platform_device *pdev)
 382 {
 383         return snd_soc_register_codec(&pdev->dev,
 384                         &soc_codec_dev_stac9766, stac9766_dai, ARRAY_SIZE(stac9766_dai));
 385 }
 386
 387 static int stac9766_remove(struct platform_device *pdev)
 388 {
 389         snd_soc_unregister_codec(&pdev->dev);
 390         return 0;
 391 }
 392
 393 static struct platform_driver stac9766_codec_driver = {
 394         .driver = {
 395                         .name = "stac9766-codec",
 396         },
 397
 398         .probe = stac9766_probe,
 399         .remove = stac9766_remove,
 400 };
 401
 402 module_platform_driver(stac9766_codec_driver);
 403
 404 MODULE_DESCRIPTION("ASoC stac9766 driver");
 405 MODULE_AUTHOR("Jon Smirl <jonsmirl@gmail.com>");
 406 MODULE_LICENSE("GPL");