LXR linux/sound/soc/codecs/ad1980.c

   1/*
   2 * ad1980.c  --  ALSA Soc AD1980 codec support
   3 *
   4 * Copyright:   Analog Device Inc.
   5 * Author:      Roy Huang <roy.huang@analog.com>
   6 *              Cliff Cai <cliff.cai@analog.com>
   7 *
   8 *  This program is free software; you can redistribute  it and/or modify it
   9 *  under  the terms of  the GNU General  Public License as published by the
  10 *  Free Software Foundation;  either version 2 of the  License, or (at your
  11 *  option) any later version.
  12 */
  13
  14/*
  15 * WARNING:
  16 *
  17 * Because Analog Devices Inc. discontinued the ad1980 sound chip since
  18 * Sep. 2009, this ad1980 driver is not maintained, tested and supported
  19 * by ADI now.
  20 */
  21
  22#include <linux/init.h>
  23#include <linux/slab.h>
  24#include <linux/module.h>
  25#include <linux/kernel.h>
  26#include <linux/device.h>
  27#include <sound/core.h>
  28#include <sound/pcm.h>
  29#include <sound/ac97_codec.h>
  30#include <sound/initval.h>
  31#include <sound/soc.h>
  32
  33#include "ad1980.h"
  34
  35/*
  36 * AD1980 register cache
  37 */
  38static const u16 ad1980_reg[] = {
  39        0x0090, 0x8000, 0x8000, 0x8000, /* 0 - 6  */
  40        0x0000, 0x0000, 0x8008, 0x8008, /* 8 - e  */
  41        0x8808, 0x8808, 0x0000, 0x8808, /* 10 - 16 */
  42        0x8808, 0x0000, 0x8000, 0x0000, /* 18 - 1e */
  43        0x0000, 0x0000, 0x0000, 0x0000, /* 20 - 26 */
  44        0x03c7, 0x0000, 0xbb80, 0xbb80, /* 28 - 2e */
  45        0xbb80, 0xbb80, 0x0000, 0x8080, /* 30 - 36 */
  46        0x8080, 0x2000, 0x0000, 0x0000, /* 38 - 3e */
  47        0x0000, 0x0000, 0x0000, 0x0000, /* reserved */
  48        0x0000, 0x0000, 0x0000, 0x0000, /* reserved */
  49        0x0000, 0x0000, 0x0000, 0x0000, /* reserved */
  50        0x0000, 0x0000, 0x0000, 0x0000, /* reserved */
  51        0x8080, 0x0000, 0x0000, 0x0000, /* 60 - 66 */
  52        0x0000, 0x0000, 0x0000, 0x0000, /* reserved */
  53        0x0000, 0x0000, 0x1001, 0x0000, /* 70 - 76 */
  54        0x0000, 0x0000, 0x4144, 0x5370  /* 78 - 7e */
  55};
  56
  57static const char *ad1980_rec_sel[] = {"Mic", "CD", "NC", "AUX", "Line",
  58                "Stereo Mix", "Mono Mix", "Phone"};
  59
  60static const struct soc_enum ad1980_cap_src =
  61        SOC_ENUM_DOUBLE(AC97_REC_SEL, 8, 0, 7, ad1980_rec_sel);
  62
  63static const struct snd_kcontrol_new ad1980_snd_ac97_controls[] = {
  64SOC_DOUBLE("Master Playback Volume", AC97_MASTER, 8, 0, 31, 1),
  65SOC_SINGLE("Master Playback Switch", AC97_MASTER, 15, 1, 1),
  66
  67SOC_DOUBLE("Headphone Playback Volume", AC97_HEADPHONE, 8, 0, 31, 1),
  68SOC_SINGLE("Headphone Playback Switch", AC97_HEADPHONE, 15, 1, 1),
  69
  70SOC_DOUBLE("PCM Playback Volume", AC97_PCM, 8, 0, 31, 1),
  71SOC_SINGLE("PCM Playback Switch", AC97_PCM, 15, 1, 1),
  72
  73SOC_DOUBLE("PCM Capture Volume", AC97_REC_GAIN, 8, 0, 31, 0),
  74SOC_SINGLE("PCM Capture Switch", AC97_REC_GAIN, 15, 1, 1),
  75
  76SOC_SINGLE("Mono Playback Volume", AC97_MASTER_MONO, 0, 31, 1),
  77SOC_SINGLE("Mono Playback Switch", AC97_MASTER_MONO, 15, 1, 1),
  78
  79SOC_SINGLE("Phone Capture Volume", AC97_PHONE, 0, 31, 1),
  80SOC_SINGLE("Phone Capture Switch", AC97_PHONE, 15, 1, 1),
  81
  82SOC_SINGLE("Mic Volume", AC97_MIC, 0, 31, 1),
  83SOC_SINGLE("Mic Switch", AC97_MIC, 15, 1, 1),
  84
  85SOC_SINGLE("Stereo Mic Switch", AC97_AD_MISC, 6, 1, 0),
  86SOC_DOUBLE("Line HP Swap Switch", AC97_AD_MISC, 10, 5, 1, 0),
  87
  88SOC_DOUBLE("Surround Playback Volume", AC97_SURROUND_MASTER, 8, 0, 31, 1),
  89SOC_DOUBLE("Surround Playback Switch", AC97_SURROUND_MASTER, 15, 7, 1, 1),
  90
  91SOC_DOUBLE("Center/LFE Playback Volume", AC97_CENTER_LFE_MASTER, 8, 0, 31, 1),
  92SOC_DOUBLE("Center/LFE Playback Switch", AC97_CENTER_LFE_MASTER, 15, 7, 1, 1),
  93
  94SOC_ENUM("Capture Source", ad1980_cap_src),
  95
  96SOC_SINGLE("Mic Boost Switch", AC97_MIC, 6, 1, 0),
  97};
  98
  99static unsigned int ac97_read(struct snd_soc_codec *codec,
 100        unsigned int reg)
 101{
 102        u16 *cache = codec->reg_cache;
 103
 104        switch (reg) {
 105        case AC97_RESET:
 106        case AC97_INT_PAGING:
 107        case AC97_POWERDOWN:
 108        case AC97_EXTENDED_STATUS:
 109        case AC97_VENDOR_ID1:
 110        case AC97_VENDOR_ID2:
 111                return soc_ac97_ops.read(codec->ac97, reg);
 112        default:
 113                reg = reg >> 1;
 114
 115                if (reg >= ARRAY_SIZE(ad1980_reg))
 116                        return -EINVAL;
 117
 118                return cache[reg];
 119        }
 120}
 121
 122static int ac97_write(struct snd_soc_codec *codec, unsigned int reg,
 123        unsigned int val)
 124{
 125        u16 *cache = codec->reg_cache;
 126
 127        soc_ac97_ops.write(codec->ac97, reg, val);
 128        reg = reg >> 1;
 129        if (reg < ARRAY_SIZE(ad1980_reg))
 130                cache[reg] = val;
 131
 132        return 0;
 133}
 134
 135static struct snd_soc_dai_driver ad1980_dai = {
 136        .name = "ad1980-hifi",
 137        .ac97_control = 1,
 138        .playback = {
 139                .stream_name = "Playback",
 140                .channels_min = 2,
 141                .channels_max = 6,
 142                .rates = SNDRV_PCM_RATE_48000,
 143                .formats = SND_SOC_STD_AC97_FMTS, },
 144        .capture = {
 145                .stream_name = "Capture",
 146                .channels_min = 2,
 147                .channels_max = 2,
 148                .rates = SNDRV_PCM_RATE_48000,
 149                .formats = SND_SOC_STD_AC97_FMTS, },
 150};
 151
 152static int ad1980_reset(struct snd_soc_codec *codec, int try_warm)
 153{
 154        u16 retry_cnt = 0;
 155
 156retry:
 157        if (try_warm && soc_ac97_ops.warm_reset) {
 158                soc_ac97_ops.warm_reset(codec->ac97);
 159                if (ac97_read(codec, AC97_RESET) == 0x0090)
 160                        return 1;
 161        }
 162
 163        soc_ac97_ops.reset(codec->ac97);
 164        /* Set bit 16slot in register 74h, then every slot will has only 16
 165         * bits. This command is sent out in 20bit mode, in which case the
 166         * first nibble of data is eaten by the addr. (Tag is always 16 bit)*/
 167        ac97_write(codec, AC97_AD_SERIAL_CFG, 0x9900);
 168
 169        if (ac97_read(codec, AC97_RESET)  != 0x0090)
 170                goto err;
 171        return 0;
 172
 173err:
 174        while (retry_cnt++ < 10)
 175                goto retry;
 176
 177        printk(KERN_ERR "AD1980 AC97 reset failed\n");
 178        return -EIO;
 179}
 180
 181static int ad1980_soc_probe(struct snd_soc_codec *codec)
 182{
 183        int ret;
 184        u16 vendor_id2;
 185        u16 ext_status;
 186
 187        printk(KERN_INFO "AD1980 SoC Audio Codec\n");
 188
 189        codec->control_data = codec;    /* we don't use regmap! */
 190        ret = snd_soc_new_ac97_codec(codec, &soc_ac97_ops, 0);
 191        if (ret < 0) {
 192                printk(KERN_ERR "ad1980: failed to register AC97 codec\n");
 193                return ret;
 194        }
 195
 196        ret = ad1980_reset(codec, 0);
 197        if (ret < 0) {
 198                printk(KERN_ERR "Failed to reset AD1980: AC97 link error\n");
 199                goto reset_err;
 200        }
 201
 202        /* Read out vendor ID to make sure it is ad1980 */
 203        if (ac97_read(codec, AC97_VENDOR_ID1) != 0x4144) {
 204                ret = -ENODEV;
 205                goto reset_err;
 206        }
 207
 208        vendor_id2 = ac97_read(codec, AC97_VENDOR_ID2);
 209
 210        if (vendor_id2 != 0x5370) {
 211                if (vendor_id2 != 0x5374) {
 212                        ret = -ENODEV;
 213                        goto reset_err;
 214                } else {
 215                        printk(KERN_WARNING "ad1980: "
 216                                "Found AD1981 - only 2/2 IN/OUT Channels "
 217                                "supported\n");
 218                }
 219        }
 220
 221        /* unmute captures and playbacks volume */
 222        ac97_write(codec, AC97_MASTER, 0x0000);
 223        ac97_write(codec, AC97_PCM, 0x0000);
 224        ac97_write(codec, AC97_REC_GAIN, 0x0000);
 225        ac97_write(codec, AC97_CENTER_LFE_MASTER, 0x0000);
 226        ac97_write(codec, AC97_SURROUND_MASTER, 0x0000);
 227
 228        /*power on LFE/CENTER/Surround DACs*/
 229        ext_status = ac97_read(codec, AC97_EXTENDED_STATUS);
 230        ac97_write(codec, AC97_EXTENDED_STATUS, ext_status&~0x3800);
 231
 232        snd_soc_add_codec_controls(codec, ad1980_snd_ac97_controls,
 233                                ARRAY_SIZE(ad1980_snd_ac97_controls));
 234
 235        return 0;
 236
 237reset_err:
 238        snd_soc_free_ac97_codec(codec);
 239        return ret;
 240}
 241
 242static int ad1980_soc_remove(struct snd_soc_codec *codec)
 243{
 244        snd_soc_free_ac97_codec(codec);
 245        return 0;
 246}
 247
 248static struct snd_soc_codec_driver soc_codec_dev_ad1980 = {
 249        .probe =        ad1980_soc_probe,
 250        .remove =       ad1980_soc_remove,
 251        .reg_cache_size = ARRAY_SIZE(ad1980_reg),
 252        .reg_word_size = sizeof(u16),
 253        .reg_cache_default = ad1980_reg,
 254        .reg_cache_step = 2,
 255        .write = ac97_write,
 256        .read = ac97_read,
 257};
 258
 259static __devinit int ad1980_probe(struct platform_device *pdev)
 260{
 261        return snd_soc_register_codec(&pdev->dev,
 262                        &soc_codec_dev_ad1980, &ad1980_dai, 1);
 263}
 264
 265static int __devexit ad1980_remove(struct platform_device *pdev)
 266{
 267        snd_soc_unregister_codec(&pdev->dev);
 268        return 0;
 269}
 270
 271static struct platform_driver ad1980_codec_driver = {
 272        .driver = {
 273                        .name = "ad1980",
 274                        .owner = THIS_MODULE,
 275        },
 276
 277        .probe = ad1980_probe,
 278        .remove = __devexit_p(ad1980_remove),
 279};
 280
 281module_platform_driver(ad1980_codec_driver);
 282
 283MODULE_DESCRIPTION("ASoC ad1980 driver (Obsolete)");
 284MODULE_AUTHOR("Roy Huang, Cliff Cai");
 285MODULE_LICENSE("GPL");
 286