// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *   ALSA driver for VIA VT82xx (South Bridge)
 *
 *   VT82C686A/B/C, VT8233A/C, VT8235
 *
 *      Copyright (c) 2000 Jaroslav Kysela <perex@perex.cz>
 *                         Tjeerd.Mulder <Tjeerd.Mulder@fujitsu-siemens.com>
 *                    2002 Takashi Iwai <tiwai@suse.de>
 */

/*
 * Changes:
 *
 * Dec. 19, 2002        Takashi Iwai <tiwai@suse.de>
 *      - use the DSX channels for the first pcm playback.
 *        (on VIA8233, 8233C and 8235 only)
 *        this will allow you play simultaneously up to 4 streams.
 *        multi-channel playback is assigned to the second device
 *        on these chips.
 *      - support the secondary capture (on VIA8233/C,8235)
 *      - SPDIF support
 *        the DSX3 channel can be used for SPDIF output.
 *        on VIA8233A, this channel is assigned to the second pcm
 *        playback.
 *        the card config of alsa-lib will assign the correct
 *        device for applications.
 *      - clean up the code, separate low-level initialization
 *        routines for each chipset.
 *
 * Sep. 26, 2005        Karsten Wiese <annabellesgarden@yahoo.de>
 *      - Optimize position calculation for the 823x chips. 
 */

#include <linux/io.h>
#include <linux/delay.h>
#include <linux/interrupt.h>
#include <linux/init.h>
#include <linux/pci.h>
#include <linux/slab.h>
#include <linux/gameport.h>
#include <linux/module.h>
#include <sound/core.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/info.h>
#include <sound/tlv.h>
#include <sound/ac97_codec.h>
#include <sound/mpu401.h>
#include <sound/initval.h>

#if 0
#define POINTER_DEBUG
#endif

MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
MODULE_DESCRIPTION("VIA VT82xx audio");
MODULE_LICENSE("GPL");

#if IS_REACHABLE(CONFIG_GAMEPORT)
#define SUPPORT_JOYSTICK 1
#endif

static int index = SNDRV_DEFAULT_IDX1;  /* Index 0-MAX */
static char *id = SNDRV_DEFAULT_STR1;   /* ID for this card */
static long mpu_port;
#ifdef SUPPORT_JOYSTICK
static bool joystick;
#endif
static int ac97_clock = 48000;
static char *ac97_quirk;
static int dxs_support;
static int dxs_init_volume = 31;
static int nodelay;

module_param(index, int, 0444);
MODULE_PARM_DESC(index, "Index value for VIA 82xx bridge.");
module_param(id, charp, 0444);
MODULE_PARM_DESC(id, "ID string for VIA 82xx bridge.");
module_param_hw(mpu_port, long, ioport, 0444);
MODULE_PARM_DESC(mpu_port, "MPU-401 port. (VT82C686x only)");
#ifdef SUPPORT_JOYSTICK
module_param(joystick, bool, 0444);
MODULE_PARM_DESC(joystick, "Enable joystick. (VT82C686x only)");
#endif
module_param(ac97_clock, int, 0444);
MODULE_PARM_DESC(ac97_clock, "AC'97 codec clock (default 48000Hz).");
module_param(ac97_quirk, charp, 0444);
MODULE_PARM_DESC(ac97_quirk, "AC'97 workaround for strange hardware.");
module_param(dxs_support, int, 0444);
MODULE_PARM_DESC(dxs_support, "Support for DXS channels (0 = auto, 1 = enable, 2 = disable, 3 = 48k only, 4 = no VRA, 5 = enable any sample rate)");
module_param(dxs_init_volume, int, 0644);
MODULE_PARM_DESC(dxs_init_volume, "initial DXS volume (0-31)");
module_param(nodelay, int, 0444);
MODULE_PARM_DESC(nodelay, "Disable 500ms init delay");

/* just for backward compatibility */
static bool enable;
module_param(enable, bool, 0444);


/* revision numbers for via686 */
#define VIA_REV_686_A           0x10
#define VIA_REV_686_B           0x11
#define VIA_REV_686_C           0x12
#define VIA_REV_686_D           0x13
#define VIA_REV_686_E           0x14
#define VIA_REV_686_H           0x20

/* revision numbers for via8233 */
#define VIA_REV_PRE_8233        0x10    /* not in market */
#define VIA_REV_8233C           0x20    /* 2 rec, 4 pb, 1 multi-pb */
#define VIA_REV_8233            0x30    /* 2 rec, 4 pb, 1 multi-pb, spdif */
#define VIA_REV_8233A           0x40    /* 1 rec, 1 multi-pb, spdf */
#define VIA_REV_8235            0x50    /* 2 rec, 4 pb, 1 multi-pb, spdif */
#define VIA_REV_8237            0x60
#define VIA_REV_8251            0x70

/*
 *  Direct registers
 */

#define VIAREG(via, x) ((via)->port + VIA_REG_##x)
#define VIADEV_REG(viadev, x) ((viadev)->port + VIA_REG_##x)

/* common offsets */
#define VIA_REG_OFFSET_STATUS           0x00    /* byte - channel status */
#define   VIA_REG_STAT_ACTIVE           0x80    /* RO */
#define   VIA8233_SHADOW_STAT_ACTIVE    0x08    /* RO */
#define   VIA_REG_STAT_PAUSED           0x40    /* RO */
#define   VIA_REG_STAT_TRIGGER_QUEUED   0x08    /* RO */
#define   VIA_REG_STAT_STOPPED          0x04    /* RWC */
#define   VIA_REG_STAT_EOL              0x02    /* RWC */
#define   VIA_REG_STAT_FLAG             0x01    /* RWC */
#define VIA_REG_OFFSET_CONTROL          0x01    /* byte - channel control */
#define   VIA_REG_CTRL_START            0x80    /* WO */
#define   VIA_REG_CTRL_TERMINATE        0x40    /* WO */
#define   VIA_REG_CTRL_AUTOSTART        0x20
#define   VIA_REG_CTRL_PAUSE            0x08    /* RW */
#define   VIA_REG_CTRL_INT_STOP         0x04            
#define   VIA_REG_CTRL_INT_EOL          0x02
#define   VIA_REG_CTRL_INT_FLAG         0x01
#define   VIA_REG_CTRL_RESET            0x01    /* RW - probably reset? undocumented */
#define   VIA_REG_CTRL_INT (VIA_REG_CTRL_INT_FLAG | VIA_REG_CTRL_INT_EOL | VIA_REG_CTRL_AUTOSTART)
#define VIA_REG_OFFSET_TYPE             0x02    /* byte - channel type (686 only) */
#define   VIA_REG_TYPE_AUTOSTART        0x80    /* RW - autostart at EOL */
#define   VIA_REG_TYPE_16BIT            0x20    /* RW */
#define   VIA_REG_TYPE_STEREO           0x10    /* RW */
#define   VIA_REG_TYPE_INT_LLINE        0x00
#define   VIA_REG_TYPE_INT_LSAMPLE      0x04
#define   VIA_REG_TYPE_INT_LESSONE      0x08
#define   VIA_REG_TYPE_INT_MASK         0x0c
#define   VIA_REG_TYPE_INT_EOL          0x02
#define   VIA_REG_TYPE_INT_FLAG         0x01
#define VIA_REG_OFFSET_TABLE_PTR        0x04    /* dword - channel table pointer */
#define VIA_REG_OFFSET_CURR_PTR         0x04    /* dword - channel current pointer */
#define VIA_REG_OFFSET_STOP_IDX         0x08    /* dword - stop index, channel type, sample rate */
#define   VIA8233_REG_TYPE_16BIT        0x00200000      /* RW */
#define   VIA8233_REG_TYPE_STEREO       0x00100000      /* RW */
#define VIA_REG_OFFSET_CURR_COUNT       0x0c    /* dword - channel current count (24 bit) */
#define VIA_REG_OFFSET_CURR_INDEX       0x0f    /* byte - channel current index (for via8233 only) */

#define DEFINE_VIA_REGSET(name,val) \
enum {\
        VIA_REG_##name##_STATUS         = (val),\
        VIA_REG_##name##_CONTROL        = (val) + 0x01,\
        VIA_REG_##name##_TYPE           = (val) + 0x02,\
        VIA_REG_##name##_TABLE_PTR      = (val) + 0x04,\
        VIA_REG_##name##_CURR_PTR       = (val) + 0x04,\
        VIA_REG_##name##_STOP_IDX       = (val) + 0x08,\
        VIA_REG_##name##_CURR_COUNT     = (val) + 0x0c,\
}

/* playback block */
DEFINE_VIA_REGSET(PLAYBACK, 0x00);
DEFINE_VIA_REGSET(CAPTURE, 0x10);
DEFINE_VIA_REGSET(FM, 0x20);

/* AC'97 */
#define VIA_REG_AC97                    0x80    /* dword */
#define   VIA_REG_AC97_CODEC_ID_MASK    (3<<30)
#define   VIA_REG_AC97_CODEC_ID_SHIFT   30
#define   VIA_REG_AC97_CODEC_ID_PRIMARY 0x00
#define   VIA_REG_AC97_CODEC_ID_SECONDARY 0x01
#define   VIA_REG_AC97_SECONDARY_VALID  (1<<27)
#define   VIA_REG_AC97_PRIMARY_VALID    (1<<25)
#define   VIA_REG_AC97_BUSY             (1<<24)
#define   VIA_REG_AC97_READ             (1<<23)
#define   VIA_REG_AC97_CMD_SHIFT        16
#define   VIA_REG_AC97_CMD_MASK         0x7e
#define   VIA_REG_AC97_DATA_SHIFT       0
#define   VIA_REG_AC97_DATA_MASK        0xffff

#define VIA_REG_SGD_SHADOW              0x84    /* dword */
/* via686 */
#define   VIA_REG_SGD_STAT_PB_FLAG      (1<<0)
#define   VIA_REG_SGD_STAT_CP_FLAG      (1<<1)
#define   VIA_REG_SGD_STAT_FM_FLAG      (1<<2)
#define   VIA_REG_SGD_STAT_PB_EOL       (1<<4)
#define   VIA_REG_SGD_STAT_CP_EOL       (1<<5)
#define   VIA_REG_SGD_STAT_FM_EOL       (1<<6)
#define   VIA_REG_SGD_STAT_PB_STOP      (1<<8)
#define   VIA_REG_SGD_STAT_CP_STOP      (1<<9)
#define   VIA_REG_SGD_STAT_FM_STOP      (1<<10)
#define   VIA_REG_SGD_STAT_PB_ACTIVE    (1<<12)
#define   VIA_REG_SGD_STAT_CP_ACTIVE    (1<<13)
#define   VIA_REG_SGD_STAT_FM_ACTIVE    (1<<14)
/* via8233 */
#define   VIA8233_REG_SGD_STAT_FLAG     (1<<0)
#define   VIA8233_REG_SGD_STAT_EOL      (1<<1)
#define   VIA8233_REG_SGD_STAT_STOP     (1<<2)
#define   VIA8233_REG_SGD_STAT_ACTIVE   (1<<3)
#define VIA8233_INTR_MASK(chan) ((VIA8233_REG_SGD_STAT_FLAG|VIA8233_REG_SGD_STAT_EOL) << ((chan) * 4))
#define   VIA8233_REG_SGD_CHAN_SDX      0
#define   VIA8233_REG_SGD_CHAN_MULTI    4
#define   VIA8233_REG_SGD_CHAN_REC      6
#define   VIA8233_REG_SGD_CHAN_REC1     7

#define VIA_REG_GPI_STATUS              0x88
#define VIA_REG_GPI_INTR                0x8c

/* multi-channel and capture registers for via8233 */
DEFINE_VIA_REGSET(MULTPLAY, 0x40);
DEFINE_VIA_REGSET(CAPTURE_8233, 0x60);

/* via8233-specific registers */
#define VIA_REG_OFS_PLAYBACK_VOLUME_L   0x02    /* byte */
#define VIA_REG_OFS_PLAYBACK_VOLUME_R   0x03    /* byte */
#define VIA_REG_OFS_MULTPLAY_FORMAT     0x02    /* byte - format and channels */
#define   VIA_REG_MULTPLAY_FMT_8BIT     0x00
#define   VIA_REG_MULTPLAY_FMT_16BIT    0x80
#define   VIA_REG_MULTPLAY_FMT_CH_MASK  0x70    /* # channels << 4 (valid = 1,2,4,6) */
#define VIA_REG_OFS_CAPTURE_FIFO        0x02    /* byte - bit 6 = fifo  enable */
#define   VIA_REG_CAPTURE_FIFO_ENABLE   0x40

#define VIA_DXS_MAX_VOLUME              31      /* max. volume (attenuation) of reg 0x32/33 */

#define VIA_REG_CAPTURE_CHANNEL         0x63    /* byte - input select */
#define   VIA_REG_CAPTURE_CHANNEL_MIC   0x4
#define   VIA_REG_CAPTURE_CHANNEL_LINE  0
#define   VIA_REG_CAPTURE_SELECT_CODEC  0x03    /* recording source codec (0 = primary) */

#define VIA_TBL_BIT_FLAG        0x40000000
#define VIA_TBL_BIT_EOL         0x80000000

/* pci space */
#define VIA_ACLINK_STAT         0x40
#define  VIA_ACLINK_C11_READY   0x20
#define  VIA_ACLINK_C10_READY   0x10
#define  VIA_ACLINK_C01_READY   0x04 /* secondary codec ready */
#define  VIA_ACLINK_LOWPOWER    0x02 /* low-power state */
#define  VIA_ACLINK_C00_READY   0x01 /* primary codec ready */
#define VIA_ACLINK_CTRL         0x41
#define  VIA_ACLINK_CTRL_ENABLE 0x80 /* 0: disable, 1: enable */
#define  VIA_ACLINK_CTRL_RESET  0x40 /* 0: assert, 1: de-assert */
#define  VIA_ACLINK_CTRL_SYNC   0x20 /* 0: release SYNC, 1: force SYNC hi */
#define  VIA_ACLINK_CTRL_SDO    0x10 /* 0: release SDO, 1: force SDO hi */
#define  VIA_ACLINK_CTRL_VRA    0x08 /* 0: disable VRA, 1: enable VRA */
#define  VIA_ACLINK_CTRL_PCM    0x04 /* 0: disable PCM, 1: enable PCM */
#define  VIA_ACLINK_CTRL_FM     0x02 /* via686 only */
#define  VIA_ACLINK_CTRL_SB     0x01 /* via686 only */
#define  VIA_ACLINK_CTRL_INIT   (VIA_ACLINK_CTRL_ENABLE|\
                                 VIA_ACLINK_CTRL_RESET|\
                                 VIA_ACLINK_CTRL_PCM|\
                                 VIA_ACLINK_CTRL_VRA)
#define VIA_FUNC_ENABLE         0x42
#define  VIA_FUNC_MIDI_PNP      0x80 /* FIXME: it's 0x40 in the datasheet! */
#define  VIA_FUNC_MIDI_IRQMASK  0x40 /* FIXME: not documented! */
#define  VIA_FUNC_RX2C_WRITE    0x20
#define  VIA_FUNC_SB_FIFO_EMPTY 0x10
#define  VIA_FUNC_ENABLE_GAME   0x08
#define  VIA_FUNC_ENABLE_FM     0x04
#define  VIA_FUNC_ENABLE_MIDI   0x02
#define  VIA_FUNC_ENABLE_SB     0x01
#define VIA_PNP_CONTROL         0x43
#define VIA_FM_NMI_CTRL         0x48
#define VIA8233_VOLCHG_CTRL     0x48
#define VIA8233_SPDIF_CTRL      0x49
#define  VIA8233_SPDIF_DX3      0x08
#define  VIA8233_SPDIF_SLOT_MASK        0x03
#define  VIA8233_SPDIF_SLOT_1011        0x00
#define  VIA8233_SPDIF_SLOT_34          0x01
#define  VIA8233_SPDIF_SLOT_78          0x02
#define  VIA8233_SPDIF_SLOT_69          0x03

/*
 */

#define VIA_DXS_AUTO    0
#define VIA_DXS_ENABLE  1
#define VIA_DXS_DISABLE 2
#define VIA_DXS_48K     3
#define VIA_DXS_NO_VRA  4
#define VIA_DXS_SRC     5


/*
 * pcm stream
 */

struct snd_via_sg_table {
        unsigned int offset;
        unsigned int size;
} ;

#define VIA_TABLE_SIZE  255
#define VIA_MAX_BUFSIZE (1<<24)

struct viadev {
        unsigned int reg_offset;
        unsigned long port;
        int direction;  /* playback = 0, capture = 1 */
        struct snd_pcm_substream *substream;
        int running;
        unsigned int tbl_entries; /* # descriptors */
        struct snd_dma_buffer table;
        struct snd_via_sg_table *idx_table;
        /* for recovery from the unexpected pointer */
        unsigned int lastpos;
        unsigned int fragsize;
        unsigned int bufsize;
        unsigned int bufsize2;
        int hwptr_done;         /* processed frame position in the buffer */
        int in_interrupt;
        int shadow_shift;
};


enum { TYPE_CARD_VIA686 = 1, TYPE_CARD_VIA8233 };
enum { TYPE_VIA686, TYPE_VIA8233, TYPE_VIA8233A };

#define VIA_MAX_DEVS    7       /* 4 playback, 1 multi, 2 capture */

struct via_rate_lock {
        spinlock_t lock;
        int rate;
        int used;
};

struct via82xx {
        int irq;

        unsigned long port;
        struct resource *mpu_res;
        int chip_type;
        unsigned char revision;

        unsigned char old_legacy;
        unsigned char old_legacy_cfg;
#ifdef CONFIG_PM_SLEEP
        unsigned char legacy_saved;
        unsigned char legacy_cfg_saved;
        unsigned char spdif_ctrl_saved;
        unsigned char capture_src_saved[2];
        unsigned int mpu_port_saved;
#endif

        unsigned char playback_volume[4][2]; /* for VIA8233/C/8235; default = 0 */
        unsigned char playback_volume_c[2]; /* for VIA8233/C/8235; default = 0 */

        unsigned int intr_mask; /* SGD_SHADOW mask to check interrupts */

        struct pci_dev *pci;
        struct snd_card *card;

        unsigned int num_devs;
        unsigned int playback_devno, multi_devno, capture_devno;
        struct viadev devs[VIA_MAX_DEVS];
        struct via_rate_lock rates[2]; /* playback and capture */
        unsigned int dxs_fixed: 1;      /* DXS channel accepts only 48kHz */
        unsigned int no_vra: 1;         /* no need to set VRA on DXS channels */
        unsigned int dxs_src: 1;        /* use full SRC capabilities of DXS */
        unsigned int spdif_on: 1;       /* only spdif rates work to external DACs */

        struct snd_pcm *pcms[2];
        struct snd_rawmidi *rmidi;
        struct snd_kcontrol *dxs_controls[4];

        struct snd_ac97_bus *ac97_bus;
        struct snd_ac97 *ac97;
        unsigned int ac97_clock;
        unsigned int ac97_secondary;    /* secondary AC'97 codec is present */

        spinlock_t reg_lock;
        struct snd_info_entry *proc_entry;

#ifdef SUPPORT_JOYSTICK
        struct gameport *gameport;
#endif
};

static const struct pci_device_id snd_via82xx_ids[] = {
        /* 0x1106, 0x3058 */
        { PCI_VDEVICE(VIA, PCI_DEVICE_ID_VIA_82C686_5), TYPE_CARD_VIA686, },    /* 686A */
        /* 0x1106, 0x3059 */
        { PCI_VDEVICE(VIA, PCI_DEVICE_ID_VIA_8233_5), TYPE_CARD_VIA8233, },     /* VT8233 */
        { 0, }
};

MODULE_DEVICE_TABLE(pci, snd_via82xx_ids);

/*
 */

/*
 * allocate and initialize the descriptor buffers
 * periods = number of periods
 * fragsize = period size in bytes
 */
static int build_via_table(struct viadev *dev, struct snd_pcm_substream *substream,
                           struct pci_dev *pci,
                           unsigned int periods, unsigned int fragsize)
{
        unsigned int i, idx, ofs, rest;
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        __le32 *pgtbl;

        if (dev->table.area == NULL) {
                /* the start of each lists must be aligned to 8 bytes,
                 * but the kernel pages are much bigger, so we don't care
                 */
                if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, &chip->pci->dev,
                                        PAGE_ALIGN(VIA_TABLE_SIZE * 2 * 8),
                                        &dev->table) < 0)
                        return -ENOMEM;
        }
        if (! dev->idx_table) {
                dev->idx_table = kmalloc_array(VIA_TABLE_SIZE,
                                               sizeof(*dev->idx_table),
                                               GFP_KERNEL);
                if (! dev->idx_table)
                        return -ENOMEM;
        }

        /* fill the entries */
        idx = 0;
        ofs = 0;
        pgtbl = (__le32 *)dev->table.area;
        for (i = 0; i < periods; i++) {
                rest = fragsize;
                /* fill descriptors for a period.
                 * a period can be split to several descriptors if it's
                 * over page boundary.
                 */
                do {
                        unsigned int r;
                        unsigned int flag;
                        unsigned int addr;

                        if (idx >= VIA_TABLE_SIZE) {
                                dev_err(&pci->dev, "too much table size!\n");
                                return -EINVAL;
                        }
                        addr = snd_pcm_sgbuf_get_addr(substream, ofs);
                        pgtbl[idx << 1] = cpu_to_le32(addr);
                        r = snd_pcm_sgbuf_get_chunk_size(substream, ofs, rest);
                        rest -= r;
                        if (! rest) {
                                if (i == periods - 1)
                                        flag = VIA_TBL_BIT_EOL; /* buffer boundary */
                                else
                                        flag = VIA_TBL_BIT_FLAG; /* period boundary */
                        } else
                                flag = 0; /* period continues to the next */
                        /*
                        dev_dbg(&pci->dev,
                                "tbl %d: at %d  size %d (rest %d)\n",
                                idx, ofs, r, rest);
                        */
                        pgtbl[(idx<<1) + 1] = cpu_to_le32(r | flag);
                        dev->idx_table[idx].offset = ofs;
                        dev->idx_table[idx].size = r;
                        ofs += r;
                        idx++;
                } while (rest > 0);
        }
        dev->tbl_entries = idx;
        dev->bufsize = periods * fragsize;
        dev->bufsize2 = dev->bufsize / 2;
        dev->fragsize = fragsize;
        return 0;
}


static int clean_via_table(struct viadev *dev, struct snd_pcm_substream *substream,
                           struct pci_dev *pci)
{
        if (dev->table.area) {
                snd_dma_free_pages(&dev->table);
                dev->table.area = NULL;
        }
        kfree(dev->idx_table);
        dev->idx_table = NULL;
        return 0;
}

/*
 *  Basic I/O
 */

static inline unsigned int snd_via82xx_codec_xread(struct via82xx *chip)
{
        return inl(VIAREG(chip, AC97));
}
 
static inline void snd_via82xx_codec_xwrite(struct via82xx *chip, unsigned int val)
{
        outl(val, VIAREG(chip, AC97));
}
 
static int snd_via82xx_codec_ready(struct via82xx *chip, int secondary)
{
        unsigned int timeout = 1000;    /* 1ms */
        unsigned int val;
        
        while (timeout-- > 0) {
                udelay(1);
                val = snd_via82xx_codec_xread(chip);
                if (!(val & VIA_REG_AC97_BUSY))
                        return val & 0xffff;
        }
        dev_err(chip->card->dev, "codec_ready: codec %i is not ready [0x%x]\n",
                   secondary, snd_via82xx_codec_xread(chip));
        return -EIO;
}
 
static int snd_via82xx_codec_valid(struct via82xx *chip, int secondary)
{
        unsigned int timeout = 1000;    /* 1ms */
        unsigned int val, val1;
        unsigned int stat = !secondary ? VIA_REG_AC97_PRIMARY_VALID :
                                         VIA_REG_AC97_SECONDARY_VALID;
        
        while (timeout-- > 0) {
                val = snd_via82xx_codec_xread(chip);
                val1 = val & (VIA_REG_AC97_BUSY | stat);
                if (val1 == stat)
                        return val & 0xffff;
                udelay(1);
        }
        return -EIO;
}
 
static void snd_via82xx_codec_wait(struct snd_ac97 *ac97)
{
        struct via82xx *chip = ac97->private_data;
        __always_unused int err;
        err = snd_via82xx_codec_ready(chip, ac97->num);
        /* here we need to wait fairly for long time.. */
        if (!nodelay)
                msleep(500);
}

static void snd_via82xx_codec_write(struct snd_ac97 *ac97,
                                    unsigned short reg,
                                    unsigned short val)
{
        struct via82xx *chip = ac97->private_data;
        unsigned int xval;

        xval = !ac97->num ? VIA_REG_AC97_CODEC_ID_PRIMARY : VIA_REG_AC97_CODEC_ID_SECONDARY;
        xval <<= VIA_REG_AC97_CODEC_ID_SHIFT;
        xval |= reg << VIA_REG_AC97_CMD_SHIFT;
        xval |= val << VIA_REG_AC97_DATA_SHIFT;
        snd_via82xx_codec_xwrite(chip, xval);
        snd_via82xx_codec_ready(chip, ac97->num);
}

static unsigned short snd_via82xx_codec_read(struct snd_ac97 *ac97, unsigned short reg)
{
        struct via82xx *chip = ac97->private_data;
        unsigned int xval, val = 0xffff;
        int again = 0;

        xval = ac97->num << VIA_REG_AC97_CODEC_ID_SHIFT;
        xval |= ac97->num ? VIA_REG_AC97_SECONDARY_VALID : VIA_REG_AC97_PRIMARY_VALID;
        xval |= VIA_REG_AC97_READ;
        xval |= (reg & 0x7f) << VIA_REG_AC97_CMD_SHIFT;
        while (1) {
                if (again++ > 3) {
                        dev_err(chip->card->dev,
                                "codec_read: codec %i is not valid [0x%x]\n",
                                   ac97->num, snd_via82xx_codec_xread(chip));
                        return 0xffff;
                }
                snd_via82xx_codec_xwrite(chip, xval);
                udelay (20);
                if (snd_via82xx_codec_valid(chip, ac97->num) >= 0) {
                        udelay(25);
                        val = snd_via82xx_codec_xread(chip);
                        break;
                }
        }
        return val & 0xffff;
}

static void snd_via82xx_channel_reset(struct via82xx *chip, struct viadev *viadev)
{
        outb(VIA_REG_CTRL_PAUSE | VIA_REG_CTRL_TERMINATE | VIA_REG_CTRL_RESET,
             VIADEV_REG(viadev, OFFSET_CONTROL));
        inb(VIADEV_REG(viadev, OFFSET_CONTROL));
        udelay(50);
        /* disable interrupts */
        outb(0x00, VIADEV_REG(viadev, OFFSET_CONTROL));
        /* clear interrupts */
        outb(0x03, VIADEV_REG(viadev, OFFSET_STATUS));
        outb(0x00, VIADEV_REG(viadev, OFFSET_TYPE)); /* for via686 */
        // outl(0, VIADEV_REG(viadev, OFFSET_CURR_PTR));
        viadev->lastpos = 0;
        viadev->hwptr_done = 0;
}


/*
 *  Interrupt handler
 *  Used for 686 and 8233A
 */
static irqreturn_t snd_via686_interrupt(int irq, void *dev_id)
{
        struct via82xx *chip = dev_id;
        unsigned int status;
        unsigned int i;

        status = inl(VIAREG(chip, SGD_SHADOW));
        if (! (status & chip->intr_mask)) {
                if (chip->rmidi)
                        /* check mpu401 interrupt */
                        return snd_mpu401_uart_interrupt(irq, chip->rmidi->private_data);
                return IRQ_NONE;
        }

        /* check status for each stream */
        spin_lock(&chip->reg_lock);
        for (i = 0; i < chip->num_devs; i++) {
                struct viadev *viadev = &chip->devs[i];
                unsigned char c_status = inb(VIADEV_REG(viadev, OFFSET_STATUS));
                if (! (c_status & (VIA_REG_STAT_EOL|VIA_REG_STAT_FLAG|VIA_REG_STAT_STOPPED)))
                        continue;
                if (viadev->substream && viadev->running) {
                        /*
                         * Update hwptr_done based on 'period elapsed'
                         * interrupts. We'll use it, when the chip returns 0 
                         * for OFFSET_CURR_COUNT.
                         */
                        if (c_status & VIA_REG_STAT_EOL)
                                viadev->hwptr_done = 0;
                        else
                                viadev->hwptr_done += viadev->fragsize;
                        viadev->in_interrupt = c_status;
                        spin_unlock(&chip->reg_lock);
                        snd_pcm_period_elapsed(viadev->substream);
                        spin_lock(&chip->reg_lock);
                        viadev->in_interrupt = 0;
                }
                outb(c_status, VIADEV_REG(viadev, OFFSET_STATUS)); /* ack */
        }
        spin_unlock(&chip->reg_lock);
        return IRQ_HANDLED;
}

/*
 *  Interrupt handler
 */
static irqreturn_t snd_via8233_interrupt(int irq, void *dev_id)
{
        struct via82xx *chip = dev_id;
        unsigned int status;
        unsigned int i;
        int irqreturn = 0;

        /* check status for each stream */
        spin_lock(&chip->reg_lock);
        status = inl(VIAREG(chip, SGD_SHADOW));

        for (i = 0; i < chip->num_devs; i++) {
                struct viadev *viadev = &chip->devs[i];
                struct snd_pcm_substream *substream;
                unsigned char c_status, shadow_status;

                shadow_status = (status >> viadev->shadow_shift) &
                        (VIA8233_SHADOW_STAT_ACTIVE|VIA_REG_STAT_EOL|
                         VIA_REG_STAT_FLAG);
                c_status = shadow_status & (VIA_REG_STAT_EOL|VIA_REG_STAT_FLAG);
                if (!c_status)
                        continue;

                substream = viadev->substream;
                if (substream && viadev->running) {
                        /*
                         * Update hwptr_done based on 'period elapsed'
                         * interrupts. We'll use it, when the chip returns 0 
                         * for OFFSET_CURR_COUNT.
                         */
                        if (c_status & VIA_REG_STAT_EOL)
                                viadev->hwptr_done = 0;
                        else
                                viadev->hwptr_done += viadev->fragsize;
                        viadev->in_interrupt = c_status;
                        if (shadow_status & VIA8233_SHADOW_STAT_ACTIVE)
                                viadev->in_interrupt |= VIA_REG_STAT_ACTIVE;
                        spin_unlock(&chip->reg_lock);

                        snd_pcm_period_elapsed(substream);

                        spin_lock(&chip->reg_lock);
                        viadev->in_interrupt = 0;
                }
                outb(c_status, VIADEV_REG(viadev, OFFSET_STATUS)); /* ack */
                irqreturn = 1;
        }
        spin_unlock(&chip->reg_lock);
        return IRQ_RETVAL(irqreturn);
}

/*
 *  PCM callbacks
 */

/*
 * trigger callback
 */
static int snd_via82xx_pcm_trigger(struct snd_pcm_substream *substream, int cmd)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;
        unsigned char val;

        if (chip->chip_type != TYPE_VIA686)
                val = VIA_REG_CTRL_INT;
        else
                val = 0;
        switch (cmd) {
        case SNDRV_PCM_TRIGGER_START:
        case SNDRV_PCM_TRIGGER_RESUME:
                val |= VIA_REG_CTRL_START;
                viadev->running = 1;
                break;
        case SNDRV_PCM_TRIGGER_STOP:
        case SNDRV_PCM_TRIGGER_SUSPEND:
                val = VIA_REG_CTRL_TERMINATE;
                viadev->running = 0;
                break;
        case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
                val |= VIA_REG_CTRL_PAUSE;
                viadev->running = 0;
                break;
        case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
                viadev->running = 1;
                break;
        default:
                return -EINVAL;
        }
        outb(val, VIADEV_REG(viadev, OFFSET_CONTROL));
        if (cmd == SNDRV_PCM_TRIGGER_STOP)
                snd_via82xx_channel_reset(chip, viadev);
        return 0;
}


/*
 * pointer callbacks
 */

/*
 * calculate the linear position at the given sg-buffer index and the rest count
 */

#define check_invalid_pos(viadev,pos) \
        ((pos) < viadev->lastpos && ((pos) >= viadev->bufsize2 ||\
                                     viadev->lastpos < viadev->bufsize2))

static inline unsigned int calc_linear_pos(struct via82xx *chip,
                                           struct viadev *viadev,
                                           unsigned int idx,
                                           unsigned int count)
{
        unsigned int size, base, res;

        size = viadev->idx_table[idx].size;
        base = viadev->idx_table[idx].offset;
        res = base + size - count;
        if (res >= viadev->bufsize)
                res -= viadev->bufsize;

        /* check the validity of the calculated position */
        if (size < count) {
                dev_dbg(chip->card->dev,
                        "invalid via82xx_cur_ptr (size = %d, count = %d)\n",
                           (int)size, (int)count);
                res = viadev->lastpos;
        } else {
                if (! count) {
                        /* Some mobos report count = 0 on the DMA boundary,
                         * i.e. count = size indeed.
                         * Let's check whether this step is above the expected size.
                         */
                        int delta = res - viadev->lastpos;
                        if (delta < 0)
                                delta += viadev->bufsize;
                        if ((unsigned int)delta > viadev->fragsize)
                                res = base;
                }
                if (check_invalid_pos(viadev, res)) {
#ifdef POINTER_DEBUG
                        dev_dbg(chip->card->dev,
                                "fail: idx = %i/%i, lastpos = 0x%x, bufsize2 = 0x%x, offsize = 0x%x, size = 0x%x, count = 0x%x\n",
                                idx, viadev->tbl_entries,
                               viadev->lastpos, viadev->bufsize2,
                               viadev->idx_table[idx].offset,
                               viadev->idx_table[idx].size, count);
#endif
                        /* count register returns full size when end of buffer is reached */
                        res = base + size;
                        if (check_invalid_pos(viadev, res)) {
                                dev_dbg(chip->card->dev,
                                        "invalid via82xx_cur_ptr (2), using last valid pointer\n");
                                res = viadev->lastpos;
                        }
                }
        }
        return res;
}

/*
 * get the current pointer on via686
 */
static snd_pcm_uframes_t snd_via686_pcm_pointer(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;
        unsigned int idx, ptr, count, res;

        if (snd_BUG_ON(!viadev->tbl_entries))
                return 0;
        if (!(inb(VIADEV_REG(viadev, OFFSET_STATUS)) & VIA_REG_STAT_ACTIVE))
                return 0;

        spin_lock(&chip->reg_lock);
        count = inl(VIADEV_REG(viadev, OFFSET_CURR_COUNT)) & 0xffffff;
        /* The via686a does not have the current index register,
         * so we need to calculate the index from CURR_PTR.
         */
        ptr = inl(VIADEV_REG(viadev, OFFSET_CURR_PTR));
        if (ptr <= (unsigned int)viadev->table.addr)
                idx = 0;
        else /* CURR_PTR holds the address + 8 */
                idx = ((ptr - (unsigned int)viadev->table.addr) / 8 - 1) % viadev->tbl_entries;
        res = calc_linear_pos(chip, viadev, idx, count);
        viadev->lastpos = res; /* remember the last position */
        spin_unlock(&chip->reg_lock);

        return bytes_to_frames(substream->runtime, res);
}

/*
 * get the current pointer on via823x
 */
static snd_pcm_uframes_t snd_via8233_pcm_pointer(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;
        unsigned int idx, count, res;
        int status;
        
        if (snd_BUG_ON(!viadev->tbl_entries))
                return 0;

        spin_lock(&chip->reg_lock);
        count = inl(VIADEV_REG(viadev, OFFSET_CURR_COUNT));
        status = viadev->in_interrupt;
        if (!status)
                status = inb(VIADEV_REG(viadev, OFFSET_STATUS));

        /* An apparent bug in the 8251 is worked around by sending a 
         * REG_CTRL_START. */
        if (chip->revision == VIA_REV_8251 && (status & VIA_REG_STAT_EOL))
                snd_via82xx_pcm_trigger(substream, SNDRV_PCM_TRIGGER_START);

        if (!(status & VIA_REG_STAT_ACTIVE)) {
                res = 0;
                goto unlock;
        }
        if (count & 0xffffff) {
                idx = count >> 24;
                if (idx >= viadev->tbl_entries) {
#ifdef POINTER_DEBUG
                        dev_dbg(chip->card->dev,
                                "fail: invalid idx = %i/%i\n", idx,
                               viadev->tbl_entries);
#endif
                        res = viadev->lastpos;
                } else {
                        count &= 0xffffff;
                        res = calc_linear_pos(chip, viadev, idx, count);
                }
        } else {
                res = viadev->hwptr_done;
                if (!viadev->in_interrupt) {
                        if (status & VIA_REG_STAT_EOL) {
                                res = 0;
                        } else
                                if (status & VIA_REG_STAT_FLAG) {
                                        res += viadev->fragsize;
                                }
                }
        }                           
unlock:
        viadev->lastpos = res;
        spin_unlock(&chip->reg_lock);

        return bytes_to_frames(substream->runtime, res);
}


/*
 * hw_params callback:
 * allocate the buffer and build up the buffer description table
 */
static int snd_via82xx_hw_params(struct snd_pcm_substream *substream,
                                 struct snd_pcm_hw_params *hw_params)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;

        return build_via_table(viadev, substream, chip->pci,
                               params_periods(hw_params),
                               params_period_bytes(hw_params));
}

/*
 * hw_free callback:
 * clean up the buffer description table and release the buffer
 */
static int snd_via82xx_hw_free(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;

        clean_via_table(viadev, substream, chip->pci);
        return 0;
}


/*
 * set up the table pointer
 */
static void snd_via82xx_set_table_ptr(struct via82xx *chip, struct viadev *viadev)
{
        snd_via82xx_codec_ready(chip, 0);
        outl((u32)viadev->table.addr, VIADEV_REG(viadev, OFFSET_TABLE_PTR));
        udelay(20);
        snd_via82xx_codec_ready(chip, 0);
}

/*
 * prepare callback for playback and capture on via686
 */
static void via686_setup_format(struct via82xx *chip, struct viadev *viadev,
                                struct snd_pcm_runtime *runtime)
{
        snd_via82xx_channel_reset(chip, viadev);
        /* this must be set after channel_reset */
        snd_via82xx_set_table_ptr(chip, viadev);
        outb(VIA_REG_TYPE_AUTOSTART |
             (runtime->format == SNDRV_PCM_FORMAT_S16_LE ? VIA_REG_TYPE_16BIT : 0) |
             (runtime->channels > 1 ? VIA_REG_TYPE_STEREO : 0) |
             ((viadev->reg_offset & 0x10) == 0 ? VIA_REG_TYPE_INT_LSAMPLE : 0) |
             VIA_REG_TYPE_INT_EOL |
             VIA_REG_TYPE_INT_FLAG, VIADEV_REG(viadev, OFFSET_TYPE));
}

static int snd_via686_playback_prepare(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;
        struct snd_pcm_runtime *runtime = substream->runtime;

        snd_ac97_set_rate(chip->ac97, AC97_PCM_FRONT_DAC_RATE, runtime->rate);
        snd_ac97_set_rate(chip->ac97, AC97_SPDIF, runtime->rate);
        via686_setup_format(chip, viadev, runtime);
        return 0;
}

static int snd_via686_capture_prepare(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;
        struct snd_pcm_runtime *runtime = substream->runtime;

        snd_ac97_set_rate(chip->ac97, AC97_PCM_LR_ADC_RATE, runtime->rate);
        via686_setup_format(chip, viadev, runtime);
        return 0;
}

/*
 * lock the current rate
 */
static int via_lock_rate(struct via_rate_lock *rec, int rate)
{
        int changed = 0;

        spin_lock_irq(&rec->lock);
        if (rec->rate != rate) {
                if (rec->rate && rec->used > 1) /* already set */
                        changed = -EINVAL;
                else {
                        rec->rate = rate;
                        changed = 1;
                }
        }
        spin_unlock_irq(&rec->lock);
        return changed;
}

/*
 * prepare callback for DSX playback on via823x
 */
static int snd_via8233_playback_prepare(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;
        struct snd_pcm_runtime *runtime = substream->runtime;
        int ac97_rate = chip->dxs_src ? 48000 : runtime->rate;
        int rate_changed;
        u32 rbits;

        rate_changed = via_lock_rate(&chip->rates[0], ac97_rate);
        if (rate_changed < 0)
                return rate_changed;
        if (rate_changed)
                snd_ac97_set_rate(chip->ac97, AC97_PCM_FRONT_DAC_RATE,
                                  chip->no_vra ? 48000 : runtime->rate);
        if (chip->spdif_on && viadev->reg_offset == 0x30)
                snd_ac97_set_rate(chip->ac97, AC97_SPDIF, runtime->rate);

        if (runtime->rate == 48000)
                rbits = 0xfffff;
        else
                rbits = (0x100000 / 48000) * runtime->rate +
                        ((0x100000 % 48000) * runtime->rate) / 48000;
        snd_BUG_ON(rbits & ~0xfffff);
        snd_via82xx_channel_reset(chip, viadev);
        snd_via82xx_set_table_ptr(chip, viadev);
        outb(chip->playback_volume[viadev->reg_offset / 0x10][0],
             VIADEV_REG(viadev, OFS_PLAYBACK_VOLUME_L));
        outb(chip->playback_volume[viadev->reg_offset / 0x10][1],
             VIADEV_REG(viadev, OFS_PLAYBACK_VOLUME_R));
        outl((runtime->format == SNDRV_PCM_FORMAT_S16_LE ? VIA8233_REG_TYPE_16BIT : 0) | /* format */
             (runtime->channels > 1 ? VIA8233_REG_TYPE_STEREO : 0) | /* stereo */
             rbits | /* rate */
             0xff000000,    /* STOP index is never reached */
             VIADEV_REG(viadev, OFFSET_STOP_IDX));
        udelay(20);
        snd_via82xx_codec_ready(chip, 0);
        return 0;
}

/*
 * prepare callback for multi-channel playback on via823x
 */
static int snd_via8233_multi_prepare(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;
        struct snd_pcm_runtime *runtime = substream->runtime;
        unsigned int slots;
        int fmt;

        if (via_lock_rate(&chip->rates[0], runtime->rate) < 0)
                return -EINVAL;
        snd_ac97_set_rate(chip->ac97, AC97_PCM_FRONT_DAC_RATE, runtime->rate);
        snd_ac97_set_rate(chip->ac97, AC97_PCM_SURR_DAC_RATE, runtime->rate);
        snd_ac97_set_rate(chip->ac97, AC97_PCM_LFE_DAC_RATE, runtime->rate);
        snd_ac97_set_rate(chip->ac97, AC97_SPDIF, runtime->rate);
        snd_via82xx_channel_reset(chip, viadev);
        snd_via82xx_set_table_ptr(chip, viadev);

        fmt = (runtime->format == SNDRV_PCM_FORMAT_S16_LE) ?
                VIA_REG_MULTPLAY_FMT_16BIT : VIA_REG_MULTPLAY_FMT_8BIT;
        fmt |= runtime->channels << 4;
        outb(fmt, VIADEV_REG(viadev, OFS_MULTPLAY_FORMAT));
#if 0
        if (chip->revision == VIA_REV_8233A)
                slots = 0;
        else
#endif
        {
                /* set sample number to slot 3, 4, 7, 8, 6, 9 (for VIA8233/C,8235) */
                /* corresponding to FL, FR, RL, RR, C, LFE ?? */
                switch (runtime->channels) {
                case 1: slots = (1<<0) | (1<<4); break;
                case 2: slots = (1<<0) | (2<<4); break;
                case 3: slots = (1<<0) | (2<<4) | (5<<8); break;
                case 4: slots = (1<<0) | (2<<4) | (3<<8) | (4<<12); break;
                case 5: slots = (1<<0) | (2<<4) | (3<<8) | (4<<12) | (5<<16); break;
                case 6: slots = (1<<0) | (2<<4) | (3<<8) | (4<<12) | (5<<16) | (6<<20); break;
                default: slots = 0; break;
                }
        }
        /* STOP index is never reached */
        outl(0xff000000 | slots, VIADEV_REG(viadev, OFFSET_STOP_IDX));
        udelay(20);
        snd_via82xx_codec_ready(chip, 0);
        return 0;
}

/*
 * prepare callback for capture on via823x
 */
static int snd_via8233_capture_prepare(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;
        struct snd_pcm_runtime *runtime = substream->runtime;

        if (via_lock_rate(&chip->rates[1], runtime->rate) < 0)
                return -EINVAL;
        snd_ac97_set_rate(chip->ac97, AC97_PCM_LR_ADC_RATE, runtime->rate);
        snd_via82xx_channel_reset(chip, viadev);
        snd_via82xx_set_table_ptr(chip, viadev);
        outb(VIA_REG_CAPTURE_FIFO_ENABLE, VIADEV_REG(viadev, OFS_CAPTURE_FIFO));
        outl((runtime->format == SNDRV_PCM_FORMAT_S16_LE ? VIA8233_REG_TYPE_16BIT : 0) |
             (runtime->channels > 1 ? VIA8233_REG_TYPE_STEREO : 0) |
             0xff000000,    /* STOP index is never reached */
             VIADEV_REG(viadev, OFFSET_STOP_IDX));
        udelay(20);
        snd_via82xx_codec_ready(chip, 0);
        return 0;
}


/*
 * pcm hardware definition, identical for both playback and capture
 */
static const struct snd_pcm_hardware snd_via82xx_hw =
{
        .info =                 (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
                                 SNDRV_PCM_INFO_BLOCK_TRANSFER |
                                 SNDRV_PCM_INFO_MMAP_VALID |
                                 /* SNDRV_PCM_INFO_RESUME | */
                                 SNDRV_PCM_INFO_PAUSE),
        .formats =              SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S16_LE,
        .rates =                SNDRV_PCM_RATE_48000,
        .rate_min =             48000,
        .rate_max =             48000,
        .channels_min =         1,
        .channels_max =         2,
        .buffer_bytes_max =     VIA_MAX_BUFSIZE,
        .period_bytes_min =     32,
        .period_bytes_max =     VIA_MAX_BUFSIZE / 2,
        .periods_min =          2,
        .periods_max =          VIA_TABLE_SIZE / 2,
        .fifo_size =            0,
};


/*
 * open callback skeleton
 */
static int snd_via82xx_pcm_open(struct via82xx *chip, struct viadev *viadev,
                                struct snd_pcm_substream *substream)
{
        struct snd_pcm_runtime *runtime = substream->runtime;
        int err;
        struct via_rate_lock *ratep;
        bool use_src = false;

        runtime->hw = snd_via82xx_hw;
        
        /* set the hw rate condition */
        ratep = &chip->rates[viadev->direction];
        spin_lock_irq(&ratep->lock);
        ratep->used++;
        if (chip->spdif_on && viadev->reg_offset == 0x30) {
                /* DXS#3 and spdif is on */
                runtime->hw.rates = chip->ac97->rates[AC97_RATES_SPDIF];
                snd_pcm_limit_hw_rates(runtime);
        } else if (chip->dxs_fixed && viadev->reg_offset < 0x40) {
                /* fixed DXS playback rate */
                runtime->hw.rates = SNDRV_PCM_RATE_48000;
                runtime->hw.rate_min = runtime->hw.rate_max = 48000;
        } else if (chip->dxs_src && viadev->reg_offset < 0x40) {
                /* use full SRC capabilities of DXS */
                runtime->hw.rates = (SNDRV_PCM_RATE_CONTINUOUS |
                                     SNDRV_PCM_RATE_8000_48000);
                runtime->hw.rate_min = 8000;
                runtime->hw.rate_max = 48000;
                use_src = true;
        } else if (! ratep->rate) {
                int idx = viadev->direction ? AC97_RATES_ADC : AC97_RATES_FRONT_DAC;
                runtime->hw.rates = chip->ac97->rates[idx];
                snd_pcm_limit_hw_rates(runtime);
        } else {
                /* a fixed rate */
                runtime->hw.rates = SNDRV_PCM_RATE_KNOT;
                runtime->hw.rate_max = runtime->hw.rate_min = ratep->rate;
        }
        spin_unlock_irq(&ratep->lock);

        /* we may remove following constaint when we modify table entries
           in interrupt */
        err = snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIODS);
        if (err < 0)
                return err;

        if (use_src) {
                err = snd_pcm_hw_rule_noresample(runtime, 48000);
                if (err < 0)
                        return err;
        }

        runtime->private_data = viadev;
        viadev->substream = substream;

        return 0;
}


/*
 * open callback for playback on via686
 */
static int snd_via686_playback_open(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = &chip->devs[chip->playback_devno + substream->number];
        int err;

        err = snd_via82xx_pcm_open(chip, viadev, substream);
        if (err < 0)
                return err;
        return 0;
}

/*
 * open callback for playback on via823x DXS
 */
static int snd_via8233_playback_open(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev;
        unsigned int stream;
        int err;

        viadev = &chip->devs[chip->playback_devno + substream->number];
        err = snd_via82xx_pcm_open(chip, viadev, substream);
        if (err < 0)
                return err;
        stream = viadev->reg_offset / 0x10;
        if (chip->dxs_controls[stream]) {
                chip->playback_volume[stream][0] =
                                VIA_DXS_MAX_VOLUME - (dxs_init_volume & 31);
                chip->playback_volume[stream][1] =
                                VIA_DXS_MAX_VOLUME - (dxs_init_volume & 31);
                chip->dxs_controls[stream]->vd[0].access &=
                        ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
                snd_ctl_notify(chip->card, SNDRV_CTL_EVENT_MASK_VALUE |
                               SNDRV_CTL_EVENT_MASK_INFO,
                               &chip->dxs_controls[stream]->id);
        }
        return 0;
}

/*
 * open callback for playback on via823x multi-channel
 */
static int snd_via8233_multi_open(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = &chip->devs[chip->multi_devno];
        int err;
        /* channels constraint for VIA8233A
         * 3 and 5 channels are not supported
         */
        static const unsigned int channels[] = {
                1, 2, 4, 6
        };
        static const struct snd_pcm_hw_constraint_list hw_constraints_channels = {
                .count = ARRAY_SIZE(channels),
                .list = channels,
                .mask = 0,
        };

        err = snd_via82xx_pcm_open(chip, viadev, substream);
        if (err < 0)
                return err;
        substream->runtime->hw.channels_max = 6;
        if (chip->revision == VIA_REV_8233A)
                snd_pcm_hw_constraint_list(substream->runtime, 0,
                                           SNDRV_PCM_HW_PARAM_CHANNELS,
                                           &hw_constraints_channels);
        return 0;
}

/*
 * open callback for capture on via686 and via823x
 */
static int snd_via82xx_capture_open(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = &chip->devs[chip->capture_devno + substream->pcm->device];

        return snd_via82xx_pcm_open(chip, viadev, substream);
}

/*
 * close callback
 */
static int snd_via82xx_pcm_close(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;
        struct via_rate_lock *ratep;

        /* release the rate lock */
        ratep = &chip->rates[viadev->direction];
        spin_lock_irq(&ratep->lock);
        ratep->used--;
        if (! ratep->used)
                ratep->rate = 0;
        spin_unlock_irq(&ratep->lock);
        if (! ratep->rate) {
                if (! viadev->direction) {
                        snd_ac97_update_power(chip->ac97,
                                              AC97_PCM_FRONT_DAC_RATE, 0);
                        snd_ac97_update_power(chip->ac97,
                                              AC97_PCM_SURR_DAC_RATE, 0);
                        snd_ac97_update_power(chip->ac97,
                                              AC97_PCM_LFE_DAC_RATE, 0);
                } else
                        snd_ac97_update_power(chip->ac97,
                                              AC97_PCM_LR_ADC_RATE, 0);
        }
        viadev->substream = NULL;
        return 0;
}

static int snd_via8233_playback_close(struct snd_pcm_substream *substream)
{
        struct via82xx *chip = snd_pcm_substream_chip(substream);
        struct viadev *viadev = substream->runtime->private_data;
        unsigned int stream;

        stream = viadev->reg_offset / 0x10;
        if (chip->dxs_controls[stream]) {
                chip->dxs_controls[stream]->vd[0].access |=
                        SNDRV_CTL_ELEM_ACCESS_INACTIVE;
                snd_ctl_notify(chip->card, SNDRV_CTL_EVENT_MASK_INFO,
                               &chip->dxs_controls[stream]->id);
        }
        return snd_via82xx_pcm_close(substream);
}


/* via686 playback callbacks */
static const struct snd_pcm_ops snd_via686_playback_ops = {
        .open =         snd_via686_playback_open,
        .close =        snd_via82xx_pcm_close,
        .hw_params =    snd_via82xx_hw_params,
        .hw_free =      snd_via82xx_hw_free,
        .prepare =      snd_via686_playback_prepare,
        .trigger =      snd_via82xx_pcm_trigger,
        .pointer =      snd_via686_pcm_pointer,
};

/* via686 capture callbacks */
static const struct snd_pcm_ops snd_via686_capture_ops = {
        .open =         snd_via82xx_capture_open,
        .close =        snd_via82xx_pcm_close,
        .hw_params =    snd_via82xx_hw_params,
        .hw_free =      snd_via82xx_hw_free,
        .prepare =      snd_via686_capture_prepare,
        .trigger =      snd_via82xx_pcm_trigger,
        .pointer =      snd_via686_pcm_pointer,
};

/* via823x DSX playback callbacks */
static const struct snd_pcm_ops snd_via8233_playback_ops = {
        .open =         snd_via8233_playback_open,
        .close =        snd_via8233_playback_close,
        .hw_params =    snd_via82xx_hw_params,
        .hw_free =      snd_via82xx_hw_free,
        .prepare =      snd_via8233_playback_prepare,
        .trigger =      snd_via82xx_pcm_trigger,
        .pointer =      snd_via8233_pcm_pointer,
};

/* via823x multi-channel playback callbacks */
static const struct snd_pcm_ops snd_via8233_multi_ops = {
        .open =         snd_via8233_multi_open,
        .close =        snd_via82xx_pcm_close,
        .hw_params =    snd_via82xx_hw_params,
        .hw_free =      snd_via82xx_hw_free,
        .prepare =      snd_via8233_multi_prepare,
        .trigger =      snd_via82xx_pcm_trigger,
        .pointer =      snd_via8233_pcm_pointer,
};

/* via823x capture callbacks */
static const struct snd_pcm_ops snd_via8233_capture_ops = {
        .open =         snd_via82xx_capture_open,
        .close =        snd_via82xx_pcm_close,
        .hw_params =    snd_via82xx_hw_params,
        .hw_free =      snd_via82xx_hw_free,
        .prepare =      snd_via8233_capture_prepare,
        .trigger =      snd_via82xx_pcm_trigger,
        .pointer =      snd_via8233_pcm_pointer,
};


static void init_viadev(struct via82xx *chip, int idx, unsigned int reg_offset,
                        int shadow_pos, int direction)
{
        chip->devs[idx].reg_offset = reg_offset;
        chip->devs[idx].shadow_shift = shadow_pos * 4;
        chip->devs[idx].direction = direction;
        chip->devs[idx].port = chip->port + reg_offset;
}

/*
 * create pcm instances for VIA8233, 8233C and 8235 (not 8233A)
 */
static int snd_via8233_pcm_new(struct via82xx *chip)
{
        struct snd_pcm *pcm;
        struct snd_pcm_chmap *chmap;
        int i, err;

        chip->playback_devno = 0;       /* x 4 */
        chip->multi_devno = 4;          /* x 1 */
        chip->capture_devno = 5;        /* x 2 */
        chip->num_devs = 7;
        chip->intr_mask = 0x33033333; /* FLAG|EOL for rec0-1, mc, sdx0-3 */

        /* PCM #0:  4 DSX playbacks and 1 capture */
        err = snd_pcm_new(chip->card, chip->card->shortname, 0, 4, 1, &pcm);
        if (err < 0)
                return err;
        snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_via8233_playback_ops);
        snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_via8233_capture_ops);
        pcm->private_data = chip;
        strcpy(pcm->name, chip->card->shortname);
        chip->pcms[0] = pcm;
        /* set up playbacks */
        for (i = 0; i < 4; i++)
                init_viadev(chip, i, 0x10 * i, i, 0);
        /* capture */
        init_viadev(chip, chip->capture_devno, VIA_REG_CAPTURE_8233_STATUS, 6, 1);

        snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV_SG,
                                       &chip->pci->dev,
                                       64*1024, VIA_MAX_BUFSIZE);

        err = snd_pcm_add_chmap_ctls(pcm, SNDRV_PCM_STREAM_PLAYBACK,
                                     snd_pcm_std_chmaps, 2, 0,
                                     &chmap);
        if (err < 0)
                return err;

        /* PCM #1:  multi-channel playback and 2nd capture */
        err = snd_pcm_new(chip->card, chip->card->shortname, 1, 1, 1, &pcm);
        if (err < 0)
                return err;
        snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_via8233_multi_ops);
        snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_via8233_capture_ops);
        pcm->private_data = chip;
        strcpy(pcm->name, chip->card->shortname);
        chip->pcms[1] = pcm;
        /* set up playback */
        init_viadev(chip, chip->multi_devno, VIA_REG_MULTPLAY_STATUS, 4, 0);
        /* set up capture */
        init_viadev(chip, chip->capture_devno + 1, VIA_REG_CAPTURE_8233_STATUS + 0x10, 7, 1);

        snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV_SG,
                                       &chip->pci->dev,
                                       64*1024, VIA_MAX_BUFSIZE);

        err = snd_pcm_add_chmap_ctls(pcm, SNDRV_PCM_STREAM_PLAYBACK,
                                     snd_pcm_alt_chmaps, 6, 0,
                                     &chmap);
        if (err < 0)
                return err;
        chip->ac97->chmaps[SNDRV_PCM_STREAM_PLAYBACK] = chmap;

        return 0;
}

/*
 * create pcm instances for VIA8233A
 */
static int snd_via8233a_pcm_new(struct via82xx *chip)
{
        struct snd_pcm *pcm;
        struct snd_pcm_chmap *chmap;
        int err;

        chip->multi_devno = 0;
        chip->playback_devno = 1;
        chip->capture_devno = 2;
        chip->num_devs = 3;
        chip->intr_mask = 0x03033000; /* FLAG|EOL for rec0, mc, sdx3 */

        /* PCM #0:  multi-channel playback and capture */
        err = snd_pcm_new(chip->card, chip->card->shortname, 0, 1, 1, &pcm);
        if (err < 0)
                return err;
        snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_via8233_multi_ops);
        snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_via8233_capture_ops);
        pcm->private_data = chip;
        strcpy(pcm->name, chip->card->shortname);
        chip->pcms[0] = pcm;
        /* set up playback */
        init_viadev(chip, chip->multi_devno, VIA_REG_MULTPLAY_STATUS, 4, 0);
        /* capture */
        init_viadev(chip, chip->capture_devno, VIA_REG_CAPTURE_8233_STATUS, 6, 1);

        snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV_SG,
                                       &chip->pci->dev,
                                       64*1024, VIA_MAX_BUFSIZE);

        err = snd_pcm_add_chmap_ctls(pcm, SNDRV_PCM_STREAM_PLAYBACK,
                                     snd_pcm_alt_chmaps, 6, 0,
                                     &chmap);
        if (err < 0)
                return err;
        chip->ac97->chmaps[SNDRV_PCM_STREAM_PLAYBACK] = chmap;

        /* SPDIF supported? */
        if (! ac97_can_spdif(chip->ac97))
                return 0;

        /* PCM #1:  DXS3 playback (for spdif) */
        err = snd_pcm_new(chip->card, chip->card->shortname, 1, 1, 0, &pcm);
        if (err < 0)
                return err;
        snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_via8233_playback_ops);
        pcm->private_data = chip;
        strcpy(pcm->name, chip->card->shortname);
        chip->pcms[1] = pcm;
        /* set up playback */
        init_viadev(chip, chip->playback_devno, 0x30, 3, 0);

        snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV_SG,
                                       &chip->pci->dev,
                                       64*1024, VIA_MAX_BUFSIZE);
        return 0;
}

/*
 * create a pcm instance for via686a/b
 */
static int snd_via686_pcm_new(struct via82xx *chip)
{
        struct snd_pcm *pcm;
        int err;

        chip->playback_devno = 0;
        chip->capture_devno = 1;
        chip->num_devs = 2;
        chip->intr_mask = 0x77; /* FLAG | EOL for PB, CP, FM */

        err = snd_pcm_new(chip->card, chip->card->shortname, 0, 1, 1, &pcm);
        if (err < 0)
                return err;
        snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_via686_playback_ops);
        snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_via686_capture_ops);
        pcm->private_data = chip;
        strcpy(pcm->name, chip->card->shortname);
        chip->pcms[0] = pcm;
        init_viadev(chip, 0, VIA_REG_PLAYBACK_STATUS, 0, 0);
        init_viadev(chip, 1, VIA_REG_CAPTURE_STATUS, 0, 1);

        snd_pcm_set_managed_buffer_all(pcm, SNDRV_DMA_TYPE_DEV_SG,
                                       &chip->pci->dev,
                                       64*1024, VIA_MAX_BUFSIZE);
        return 0;
}


/*
 *  Mixer part
 */

static int snd_via8233_capture_source_info(struct snd_kcontrol *kcontrol,
                                           struct snd_ctl_elem_info *uinfo)
{
        /* formerly they were "Line" and "Mic", but it looks like that they
         * have nothing to do with the actual physical connections...
         */
        static const char * const texts[2] = {
                "Input1", "Input2"
        };
        return snd_ctl_enum_info(uinfo, 1, 2, texts);
}

static int snd_via8233_capture_source_get(struct snd_kcontrol *kcontrol,
                                          struct snd_ctl_elem_value *ucontrol)
{
        struct via82xx *chip = snd_kcontrol_chip(kcontrol);
        unsigned long port = chip->port + (kcontrol->id.index ? (VIA_REG_CAPTURE_CHANNEL + 0x10) : VIA_REG_CAPTURE_CHANNEL);
        ucontrol->value.enumerated.item[0] = inb(port) & VIA_REG_CAPTURE_CHANNEL_MIC ? 1 : 0;
        return 0;
}

static int snd_via8233_capture_source_put(struct snd_kcontrol *kcontrol,
                                          struct snd_ctl_elem_value *ucontrol)
{
        struct via82xx *chip = snd_kcontrol_chip(kcontrol);
        unsigned long port = chip->port + (kcontrol->id.index ? (VIA_REG_CAPTURE_CHANNEL + 0x10) : VIA_REG_CAPTURE_CHANNEL);
        u8 val, oval;

        spin_lock_irq(&chip->reg_lock);
        oval = inb(port);
        val = oval & ~VIA_REG_CAPTURE_CHANNEL_MIC;
        if (ucontrol->value.enumerated.item[0])
                val |= VIA_REG_CAPTURE_CHANNEL_MIC;
        if (val != oval)
                outb(val, port);
        spin_unlock_irq(&chip->reg_lock);
        return val != oval;
}

static struct snd_kcontrol_new snd_via8233_capture_source = {
        .name = "Input Source Select",
        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
        .info = snd_via8233_capture_source_info,
        .get = snd_via8233_capture_source_get,
        .put = snd_via8233_capture_source_put,
};

#define snd_via8233_dxs3_spdif_info     snd_ctl_boolean_mono_info

static int snd_via8233_dxs3_spdif_get(struct snd_kcontrol *kcontrol,
                                      struct snd_ctl_elem_value *ucontrol)
{
        struct via82xx *chip = snd_kcontrol_chip(kcontrol);
        u8 val;

        pci_read_config_byte(chip->pci, VIA8233_SPDIF_CTRL, &val);
        ucontrol->value.integer.value[0] = (val & VIA8233_SPDIF_DX3) ? 1 : 0;
        return 0;
}

static int snd_via8233_dxs3_spdif_put(struct snd_kcontrol *kcontrol,
                                      struct snd_ctl_elem_value *ucontrol)
{
        struct via82xx *chip = snd_kcontrol_chip(kcontrol);
        u8 val, oval;

        pci_read_config_byte(chip->pci, VIA8233_SPDIF_CTRL, &oval);
        val = oval & ~VIA8233_SPDIF_DX3;
        if (ucontrol->value.integer.value[0])
                val |= VIA8233_SPDIF_DX3;
        /* save the spdif flag for rate filtering */
        chip->spdif_on = ucontrol->value.integer.value[0] ? 1 : 0;
        if (val != oval) {
                pci_write_config_byte(chip->pci, VIA8233_SPDIF_CTRL, val);
                return 1;
        }
        return 0;
}

static const struct snd_kcontrol_new snd_via8233_dxs3_spdif_control = {
        .name = SNDRV_CTL_NAME_IEC958("Output ",NONE,SWITCH),
        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
        .info = snd_via8233_dxs3_spdif_info,
        .get = snd_via8233_dxs3_spdif_get,
        .put = snd_via8233_dxs3_spdif_put,
};

static int snd_via8233_dxs_volume_info(struct snd_kcontrol *kcontrol,
                                       struct snd_ctl_elem_info *uinfo)
{
        uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
        uinfo->count = 2;
        uinfo->value.integer.min = 0;
        uinfo->value.integer.max = VIA_DXS_MAX_VOLUME;
        return 0;
}

static int snd_via8233_dxs_volume_get(struct snd_kcontrol *kcontrol,
                                      struct snd_ctl_elem_value *ucontrol)
{
        struct via82xx *chip = snd_kcontrol_chip(kcontrol);
        unsigned int idx = kcontrol->id.subdevice;

        ucontrol->value.integer.value[0] = VIA_DXS_MAX_VOLUME - chip->playback_volume[idx][0];
        ucontrol->value.integer.value[1] = VIA_DXS_MAX_VOLUME - chip->playback_volume[idx][1];
        return 0;
}

static int snd_via8233_pcmdxs_volume_get(struct snd_kcontrol *kcontrol,
                                         struct snd_ctl_elem_value *ucontrol)
{
        struct via82xx *chip = snd_kcontrol_chip(kcontrol);
        ucontrol->value.integer.value[0] = VIA_DXS_MAX_VOLUME - chip->playback_volume_c[0];
        ucontrol->value.integer.value[1] = VIA_DXS_MAX_VOLUME - chip->playback_volume_c[1];
        return 0;
}

static int snd_via8233_dxs_volume_put(struct snd_kcontrol *kcontrol,
                                      struct snd_ctl_elem_value *ucontrol)
{
        struct via82xx *chip = snd_kcontrol_chip(kcontrol);
        unsigned int idx = kcontrol->id.subdevice;
        unsigned long port = chip->port + 0x10 * idx;
        unsigned char val;
        int i, change = 0;

        for (i = 0; i < 2; i++) {
                val = ucontrol->value.integer.value[i];
                if (val > VIA_DXS_MAX_VOLUME)
                        val = VIA_DXS_MAX_VOLUME;
                val = VIA_DXS_MAX_VOLUME - val;
                change |= val != chip->playback_volume[idx][i];
                if (change) {
                        chip->playback_volume[idx][i] = val;
                        outb(val, port + VIA_REG_OFS_PLAYBACK_VOLUME_L + i);
                }
        }
        return change;
}

static int snd_via8233_pcmdxs_volume_put(struct snd_kcontrol *kcontrol,
                                         struct snd_ctl_elem_value *ucontrol)
{
        struct via82xx *chip = snd_kcontrol_chip(kcontrol);
        unsigned int idx;
        unsigned char val;
        int i, change = 0;

        for (i = 0; i < 2; i++) {
                val = ucontrol->value.integer.value[i];
                if (val > VIA_DXS_MAX_VOLUME)
                        val = VIA_DXS_MAX_VOLUME;
                val = VIA_DXS_MAX_VOLUME - val;
                if (val != chip->playback_volume_c[i]) {
                        change = 1;
                        chip->playback_volume_c[i] = val;
                        for (idx = 0; idx < 4; idx++) {
                                unsigned long port = chip->port + 0x10 * idx;
                                chip->playback_volume[idx][i] = val;
                                outb(val, port + VIA_REG_OFS_PLAYBACK_VOLUME_L + i);
                        }
                }
        }
        return change;
}

static const DECLARE_TLV_DB_SCALE(db_scale_dxs, -4650, 150, 1);

static const struct snd_kcontrol_new snd_via8233_pcmdxs_volume_control = {
        .name = "PCM Playback Volume",
        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
        .access = (SNDRV_CTL_ELEM_ACCESS_READWRITE |
                   SNDRV_CTL_ELEM_ACCESS_TLV_READ),
        .info = snd_via8233_dxs_volume_info,
        .get = snd_via8233_pcmdxs_volume_get,
        .put = snd_via8233_pcmdxs_volume_put,
        .tlv = { .p = db_scale_dxs }
};

static const struct snd_kcontrol_new snd_via8233_dxs_volume_control = {
        .iface = SNDRV_CTL_ELEM_IFACE_PCM,
        .device = 0,
        /* .subdevice set later */
        .name = "PCM Playback Volume",
        .access = SNDRV_CTL_ELEM_ACCESS_READWRITE |
                  SNDRV_CTL_ELEM_ACCESS_TLV_READ |
                  SNDRV_CTL_ELEM_ACCESS_INACTIVE,
        .info = snd_via8233_dxs_volume_info,
        .get = snd_via8233_dxs_volume_get,
        .put = snd_via8233_dxs_volume_put,
        .tlv = { .p = db_scale_dxs }
};

/*
 */

static void snd_via82xx_mixer_free_ac97_bus(struct snd_ac97_bus *bus)
{
        struct via82xx *chip = bus->private_data;
        chip->ac97_bus = NULL;
}

static void snd_via82xx_mixer_free_ac97(struct snd_ac97 *ac97)
{
        struct via82xx *chip = ac97->private_data;
        chip->ac97 = NULL;
}

static const struct ac97_quirk ac97_quirks[] = {
        {
                .subvendor = 0x1106,
                .subdevice = 0x4161,
                .codec_id = 0x56494161, /* VT1612A */
                .name = "Soltek SL-75DRV5",
                .type = AC97_TUNE_NONE
        },
        {       /* FIXME: which codec? */
                .subvendor = 0x1106,
                .subdevice = 0x4161,
                .name = "ASRock K7VT2",
                .type = AC97_TUNE_HP_ONLY
        },
        {
                .subvendor = 0x110a,
                .subdevice = 0x0079,
                .name = "Fujitsu Siemens D1289",
                .type = AC97_TUNE_HP_ONLY
        },
        {
                .subvendor = 0x1019,
                .subdevice = 0x0a81,
                .name = "ECS K7VTA3",
                .type = AC97_TUNE_HP_ONLY
        },
        {
                .subvendor = 0x1019,
                .subdevice = 0x0a85,
                .name = "ECS L7VMM2",
                .type = AC97_TUNE_HP_ONLY
        },
        {
                .subvendor = 0x1019,
                .subdevice = 0x1841,
                .name = "ECS K7VTA3",
                .type = AC97_TUNE_HP_ONLY
        },
        {
                .subvendor = 0x1849,
                .subdevice = 0x3059,
                .name = "ASRock K7VM2",
                .type = AC97_TUNE_HP_ONLY       /* VT1616 */
        },
        {
                .subvendor = 0x14cd,
                .subdevice = 0x7002,
                .name = "Unknown",
                .type = AC97_TUNE_ALC_JACK
        },
        {
                .subvendor = 0x1071,
                .subdevice = 0x8590,
                .name = "Mitac Mobo",
                .type = AC97_TUNE_ALC_JACK
        },
        {
                .subvendor = 0x161f,
                .subdevice = 0x202b,
                .name = "Arima Notebook",
                .type = AC97_TUNE_HP_ONLY,
        },
        {
                .subvendor = 0x161f,
                .subdevice = 0x2032,
                .name = "Targa Traveller 811",
                .type = AC97_TUNE_HP_ONLY,
        },
        {
                .subvendor = 0x161f,
                .subdevice = 0x2032,
                .name = "m680x",
                .type = AC97_TUNE_HP_ONLY, /* http://launchpad.net/bugs/38546 */
        },
        {
                .subvendor = 0x1297,
                .subdevice = 0xa232,
                .name = "Shuttle AK32VN",
                .type = AC97_TUNE_HP_ONLY
        },
        { } /* terminator */
};

static int snd_via82xx_mixer_new(struct via82xx *chip, const char *quirk_override)
{
        struct snd_ac97_template ac97;
        int err;
        static const struct snd_ac97_bus_ops ops = {
                .write = snd_via82xx_codec_write,
                .read = snd_via82xx_codec_read,
                .wait = snd_via82xx_codec_wait,
        };

        err = snd_ac97_bus(chip->card, 0, &ops, chip, &chip->ac97_bus);
        if (err < 0)
                return err;
        chip->ac97_bus->private_free = snd_via82xx_mixer_free_ac97_bus;
        chip->ac97_bus->clock = chip->ac97_clock;

        memset(&ac97, 0, sizeof(ac97));
        ac97.private_data = chip;
        ac97.private_free = snd_via82xx_mixer_free_ac97;
        ac97.pci = chip->pci;
        ac97.scaps = AC97_SCAP_SKIP_MODEM | AC97_SCAP_POWER_SAVE;
        err = snd_ac97_mixer(chip->ac97_bus, &ac97, &chip->ac97);
        if (err < 0)
                return err;

        snd_ac97_tune_hardware(chip->ac97, ac97_quirks, quirk_override);

        if (chip->chip_type != TYPE_VIA686) {
                /* use slot 10/11 */
                snd_ac97_update_bits(chip->ac97, AC97_EXTENDED_STATUS, 0x03 << 4, 0x03 << 4);
        }

        return 0;
}

#ifdef SUPPORT_JOYSTICK
#define JOYSTICK_ADDR   0x200
static int snd_via686_create_gameport(struct via82xx *chip, unsigned char *legacy)
{
        struct gameport *gp;

        if (!joystick)
                return -ENODEV;

        if (!devm_request_region(chip->card->dev, JOYSTICK_ADDR, 8,
                                 "VIA686 gameport")) {
                dev_warn(chip->card->dev, "cannot reserve joystick port %#x\n",
                       JOYSTICK_ADDR);
                return -EBUSY;
        }

        chip->gameport = gp = gameport_allocate_port();
        if (!gp) {
                dev_err(chip->card->dev,
                        "cannot allocate memory for gameport\n");
                return -ENOMEM;
        }

        gameport_set_name(gp, "VIA686 Gameport");
        gameport_set_phys(gp, "pci%s/gameport0", pci_name(chip->pci));
        gameport_set_dev_parent(gp, &chip->pci->dev);
        gp->io = JOYSTICK_ADDR;

        /* Enable legacy joystick port */
        *legacy |= VIA_FUNC_ENABLE_GAME;
        pci_write_config_byte(chip->pci, VIA_FUNC_ENABLE, *legacy);

        gameport_register_port(chip->gameport);

        return 0;
}

static void snd_via686_free_gameport(struct via82xx *chip)
{
        if (chip->gameport) {
                gameport_unregister_port(chip->gameport);
                chip->gameport = NULL;
        }
}
#else
static inline int snd_via686_create_gameport(struct via82xx *chip, unsigned char *legacy)
{
        return -ENOSYS;
}
static inline void snd_via686_free_gameport(struct via82xx *chip) { }
#endif


/*
 *
 */

static int snd_via8233_init_misc(struct via82xx *chip)
{
        int i, err, caps;
        unsigned char val;

        caps = chip->chip_type == TYPE_VIA8233A ? 1 : 2;
        for (i = 0; i < caps; i++) {
                snd_via8233_capture_source.index = i;
                err = snd_ctl_add(chip->card, snd_ctl_new1(&snd_via8233_capture_source, chip));
                if (err < 0)
                        return err;
        }
        if (ac97_can_spdif(chip->ac97)) {
                err = snd_ctl_add(chip->card, snd_ctl_new1(&snd_via8233_dxs3_spdif_control, chip));
                if (err < 0)
                        return err;
        }
        if (chip->chip_type != TYPE_VIA8233A) {
                /* when no h/w PCM volume control is found, use DXS volume control
                 * as the PCM vol control
                 */
                struct snd_ctl_elem_id sid;
                memset(&sid, 0, sizeof(sid));
                strcpy(sid.name, "PCM Playback Volume");
                sid.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
                if (! snd_ctl_find_id(chip->card, &sid)) {
                        dev_info(chip->card->dev,
                                 "Using DXS as PCM Playback\n");
                        err = snd_ctl_add(chip->card, snd_ctl_new1(&snd_via8233_pcmdxs_volume_control, chip));
                        if (err < 0)
                                return err;
                }
                else /* Using DXS when PCM emulation is enabled is really weird */
                {
                        for (i = 0; i < 4; ++i) {

                                struct snd_kcontrol *kctl;

                                kctl = snd_ctl_new1(
                                        &snd_via8233_dxs_volume_control, chip);
                                if (!kctl)
                                        return -ENOMEM;
                                kctl->id.subdevice = i;
                                err = snd_ctl_add(chip->card, kctl);
                                if (err < 0)
                                        return err;
                                chip->dxs_controls[i] = kctl;
                        }
                }
        }
        /* select spdif data slot 10/11 */
        pci_read_config_byte(chip->pci, VIA8233_SPDIF_CTRL, &val);
        val = (val & ~VIA8233_SPDIF_SLOT_MASK) | VIA8233_SPDIF_SLOT_1011;
        val &= ~VIA8233_SPDIF_DX3; /* SPDIF off as default */
        pci_write_config_byte(chip->pci, VIA8233_SPDIF_CTRL, val);

        return 0;
}

static int snd_via686_init_misc(struct via82xx *chip)
{
        unsigned char legacy, legacy_cfg;
        int rev_h = 0;

        legacy = chip->old_legacy;
        legacy_cfg = chip->old_legacy_cfg;
        legacy |= VIA_FUNC_MIDI_IRQMASK;        /* FIXME: correct? (disable MIDI) */
        legacy &= ~VIA_FUNC_ENABLE_GAME;        /* disable joystick */
        if (chip->revision >= VIA_REV_686_H) {
                rev_h = 1;
                if (mpu_port >= 0x200) {        /* force MIDI */
                        mpu_port &= 0xfffc;
                        pci_write_config_dword(chip->pci, 0x18, mpu_port | 0x01);
#ifdef CONFIG_PM_SLEEP
                        chip->mpu_port_saved = mpu_port;
#endif
                } else {
                        mpu_port = pci_resource_start(chip->pci, 2);
                }
        } else {
                switch (mpu_port) {     /* force MIDI */
                case 0x300:
                case 0x310:
                case 0x320:
                case 0x330:
                        legacy_cfg &= ~(3 << 2);
                        legacy_cfg |= (mpu_port & 0x0030) >> 2;
                        break;
                default:                        /* no, use BIOS settings */
                        if (legacy & VIA_FUNC_ENABLE_MIDI)
                                mpu_port = 0x300 + ((legacy_cfg & 0x000c) << 2);
                        break;
                }
        }
        if (mpu_port >= 0x200)
                chip->mpu_res = devm_request_region(&chip->pci->dev, mpu_port,
                                                    2, "VIA82xx MPU401");
        if (chip->mpu_res) {
                if (rev_h)
                        legacy |= VIA_FUNC_MIDI_PNP;    /* enable PCI I/O 2 */
                legacy |= VIA_FUNC_ENABLE_MIDI;
        } else {
                if (rev_h)
                        legacy &= ~VIA_FUNC_MIDI_PNP;   /* disable PCI I/O 2 */
                legacy &= ~VIA_FUNC_ENABLE_MIDI;
                mpu_port = 0;
        }

        pci_write_config_byte(chip->pci, VIA_FUNC_ENABLE, legacy);
        pci_write_config_byte(chip->pci, VIA_PNP_CONTROL, legacy_cfg);
        if (chip->mpu_res) {
                if (snd_mpu401_uart_new(chip->card, 0, MPU401_HW_VIA686A,
                                        mpu_port, MPU401_INFO_INTEGRATED |
                                        MPU401_INFO_IRQ_HOOK, -1,
                                        &chip->rmidi) < 0) {
                        dev_warn(chip->card->dev,
                                 "unable to initialize MPU-401 at 0x%lx, skipping\n",
                                 mpu_port);
                        legacy &= ~VIA_FUNC_ENABLE_MIDI;
                } else {
                        legacy &= ~VIA_FUNC_MIDI_IRQMASK;       /* enable MIDI interrupt */
                }
                pci_write_config_byte(chip->pci, VIA_FUNC_ENABLE, legacy);
        }

        snd_via686_create_gameport(chip, &legacy);

#ifdef CONFIG_PM_SLEEP
        chip->legacy_saved = legacy;
        chip->legacy_cfg_saved = legacy_cfg;
#endif

        return 0;
}


/*
 * proc interface
 */
static void snd_via82xx_proc_read(struct snd_info_entry *entry,
                                  struct snd_info_buffer *buffer)
{
        struct via82xx *chip = entry->private_data;
        int i;
        
        snd_iprintf(buffer, "%s\n\n", chip->card->longname);
        for (i = 0; i < 0xa0; i += 4) {
                snd_iprintf(buffer, "%02x: %08x\n", i, inl(chip->port + i));
        }
}

static void snd_via82xx_proc_init(struct via82xx *chip)
{
        snd_card_ro_proc_new(chip->card, "via82xx", chip,
                             snd_via82xx_proc_read);
}

/*
 *
 */

static int snd_via82xx_chip_init(struct via82xx *chip)
{
        unsigned int val;
        unsigned long end_time;
        unsigned char pval;

#if 0 /* broken on K7M? */
        if (chip->chip_type == TYPE_VIA686)
                /* disable all legacy ports */
                pci_write_config_byte(chip->pci, VIA_FUNC_ENABLE, 0);
#endif
        pci_read_config_byte(chip->pci, VIA_ACLINK_STAT, &pval);
        if (! (pval & VIA_ACLINK_C00_READY)) { /* codec not ready? */
                /* deassert ACLink reset, force SYNC */
                pci_write_config_byte(chip->pci, VIA_ACLINK_CTRL,
                                      VIA_ACLINK_CTRL_ENABLE |
                                      VIA_ACLINK_CTRL_RESET |
                                      VIA_ACLINK_CTRL_SYNC);
                udelay(100);
#if 1 /* FIXME: should we do full reset here for all chip models? */
                pci_write_config_byte(chip->pci, VIA_ACLINK_CTRL, 0x00);
                udelay(100);
#else
                /* deassert ACLink reset, force SYNC (warm AC'97 reset) */
                pci_write_config_byte(chip->pci, VIA_ACLINK_CTRL,
                                      VIA_ACLINK_CTRL_RESET|VIA_ACLINK_CTRL_SYNC);
                udelay(2);
#endif
                /* ACLink on, deassert ACLink reset, VSR, SGD data out */
                /* note - FM data out has trouble with non VRA codecs !! */
                pci_write_config_byte(chip->pci, VIA_ACLINK_CTRL, VIA_ACLINK_CTRL_INIT);
                udelay(100);
        }
        
        /* Make sure VRA is enabled, in case we didn't do a
         * complete codec reset, above */
        pci_read_config_byte(chip->pci, VIA_ACLINK_CTRL, &pval);
        if ((pval & VIA_ACLINK_CTRL_INIT) != VIA_ACLINK_CTRL_INIT) {
                /* ACLink on, deassert ACLink reset, VSR, SGD data out */
                /* note - FM data out has trouble with non VRA codecs !! */
                pci_write_config_byte(chip->pci, VIA_ACLINK_CTRL, VIA_ACLINK_CTRL_INIT);
                udelay(100);
        }

        /* wait until codec ready */
        end_time = jiffies + msecs_to_jiffies(750);
        do {
                pci_read_config_byte(chip->pci, VIA_ACLINK_STAT, &pval);
                if (pval & VIA_ACLINK_C00_READY) /* primary codec ready */
                        break;
                schedule_timeout_uninterruptible(1);
        } while (time_before(jiffies, end_time));

        val = snd_via82xx_codec_xread(chip);
        if (val & VIA_REG_AC97_BUSY)
                dev_err(chip->card->dev,
                        "AC'97 codec is not ready [0x%x]\n", val);

#if 0 /* FIXME: we don't support the second codec yet so skip the detection now.. */
        snd_via82xx_codec_xwrite(chip, VIA_REG_AC97_READ |
                                 VIA_REG_AC97_SECONDARY_VALID |
                                 (VIA_REG_AC97_CODEC_ID_SECONDARY << VIA_REG_AC97_CODEC_ID_SHIFT));
        end_time = jiffies + msecs_to_jiffies(750);
        snd_via82xx_codec_xwrite(chip, VIA_REG_AC97_READ |
                                 VIA_REG_AC97_SECONDARY_VALID |
                                 (VIA_REG_AC97_CODEC_ID_SECONDARY << VIA_REG_AC97_CODEC_ID_SHIFT));
        do {
                val = snd_via82xx_codec_xread(chip);
                if (val & VIA_REG_AC97_SECONDARY_VALID) {
                        chip->ac97_secondary = 1;
                        goto __ac97_ok2;
                }
                schedule_timeout_uninterruptible(1);
        } while (time_before(jiffies, end_time));
        /* This is ok, the most of motherboards have only one codec */

      __ac97_ok2:
#endif

        if (chip->chip_type == TYPE_VIA686) {
                /* route FM trap to IRQ, disable FM trap */
                pci_write_config_byte(chip->pci, VIA_FM_NMI_CTRL, 0);
                /* disable all GPI interrupts */
                outl(0, VIAREG(chip, GPI_INTR));
        }

        if (chip->chip_type != TYPE_VIA686) {
                /* Workaround for Award BIOS bug:
                 * DXS channels don't work properly with VRA if MC97 is disabled.
                 */
                struct pci_dev *pci;
                pci = pci_get_device(0x1106, 0x3068, NULL); /* MC97 */
                if (pci) {
                        unsigned char data;
                        pci_read_config_byte(pci, 0x44, &data);
                        pci_write_config_byte(pci, 0x44, data | 0x40);
                        pci_dev_put(pci);
                }
        }

        if (chip->chip_type != TYPE_VIA8233A) {
                int i, idx;
                for (idx = 0; idx < 4; idx++) {
                        unsigned long port = chip->port + 0x10 * idx;
                        for (i = 0; i < 2; i++) {
                                chip->playback_volume[idx][i]=chip->playback_volume_c[i];
                                outb(chip->playback_volume_c[i],
                                     port + VIA_REG_OFS_PLAYBACK_VOLUME_L + i);
                        }
                }
        }

        return 0;
}

#ifdef CONFIG_PM_SLEEP
/*
 * power management
 */
static int snd_via82xx_suspend(struct device *dev)
{
        struct snd_card *card = dev_get_drvdata(dev);
        struct via82xx *chip = card->private_data;
        int i;

        snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
        for (i = 0; i < chip->num_devs; i++)
                snd_via82xx_channel_reset(chip, &chip->devs[i]);
        snd_ac97_suspend(chip->ac97);

        /* save misc values */
        if (chip->chip_type != TYPE_VIA686) {
                pci_read_config_byte(chip->pci, VIA8233_SPDIF_CTRL, &chip->spdif_ctrl_saved);
                chip->capture_src_saved[0] = inb(chip->port + VIA_REG_CAPTURE_CHANNEL);
                chip->capture_src_saved[1] = inb(chip->port + VIA_REG_CAPTURE_CHANNEL + 0x10);
        }

        return 0;
}

static int snd_via82xx_resume(struct device *dev)
{
        struct snd_card *card = dev_get_drvdata(dev);
        struct via82xx *chip = card->private_data;
        int i;

        snd_via82xx_chip_init(chip);

        if (chip->chip_type == TYPE_VIA686) {
                if (chip->mpu_port_saved)
                        pci_write_config_dword(chip->pci, 0x18, chip->mpu_port_saved | 0x01);
                pci_write_config_byte(chip->pci, VIA_FUNC_ENABLE, chip->legacy_saved);
                pci_write_config_byte(chip->pci, VIA_PNP_CONTROL, chip->legacy_cfg_saved);
        } else {
                pci_write_config_byte(chip->pci, VIA8233_SPDIF_CTRL, chip->spdif_ctrl_saved);
                outb(chip->capture_src_saved[0], chip->port + VIA_REG_CAPTURE_CHANNEL);
                outb(chip->capture_src_saved[1], chip->port + VIA_REG_CAPTURE_CHANNEL + 0x10);
        }

        snd_ac97_resume(chip->ac97);

        for (i = 0; i < chip->num_devs; i++)
                snd_via82xx_channel_reset(chip, &chip->devs[i]);

        snd_power_change_state(card, SNDRV_CTL_POWER_D0);
        return 0;
}

static SIMPLE_DEV_PM_OPS(snd_via82xx_pm, snd_via82xx_suspend, snd_via82xx_resume);
#define SND_VIA82XX_PM_OPS      &snd_via82xx_pm
#else
#define SND_VIA82XX_PM_OPS      NULL
#endif /* CONFIG_PM_SLEEP */

static void snd_via82xx_free(struct snd_card *card)
{
        struct via82xx *chip = card->private_data;
        unsigned int i;

        /* disable interrupts */
        for (i = 0; i < chip->num_devs; i++)
                snd_via82xx_channel_reset(chip, &chip->devs[i]);

        if (chip->chip_type == TYPE_VIA686) {
                snd_via686_free_gameport(chip);
                pci_write_config_byte(chip->pci, VIA_FUNC_ENABLE, chip->old_legacy);
                pci_write_config_byte(chip->pci, VIA_PNP_CONTROL, chip->old_legacy_cfg);
        }
}

static int snd_via82xx_create(struct snd_card *card,
                              struct pci_dev *pci,
                              int chip_type,
                              int revision,
                              unsigned int ac97_clock)
{
        struct via82xx *chip = card->private_data;
        int err;

        err = pcim_enable_device(pci);
        if (err < 0)
                return err;

        chip->chip_type = chip_type;
        chip->revision = revision;

        spin_lock_init(&chip->reg_lock);
        spin_lock_init(&chip->rates[0].lock);
        spin_lock_init(&chip->rates[1].lock);
        chip->card = card;
        chip->pci = pci;
        chip->irq = -1;

        pci_read_config_byte(pci, VIA_FUNC_ENABLE, &chip->old_legacy);
        pci_read_config_byte(pci, VIA_PNP_CONTROL, &chip->old_legacy_cfg);
        pci_write_config_byte(chip->pci, VIA_FUNC_ENABLE,
                              chip->old_legacy & ~(VIA_FUNC_ENABLE_SB|VIA_FUNC_ENABLE_FM));

        err = pci_request_regions(pci, card->driver);
        if (err < 0)
                return err;
        chip->port = pci_resource_start(pci, 0);
        if (devm_request_irq(&pci->dev, pci->irq,
                             chip_type == TYPE_VIA8233 ?
                             snd_via8233_interrupt : snd_via686_interrupt,
                             IRQF_SHARED,
                             KBUILD_MODNAME, chip)) {
                dev_err(card->dev, "unable to grab IRQ %d\n", pci->irq);
                return -EBUSY;
        }
        chip->irq = pci->irq;
        card->sync_irq = chip->irq;
        card->private_free = snd_via82xx_free;
        if (ac97_clock >= 8000 && ac97_clock <= 48000)
                chip->ac97_clock = ac97_clock;

        err = snd_via82xx_chip_init(chip);
        if (err < 0)
                return err;

        /* The 8233 ac97 controller does not implement the master bit
         * in the pci command register. IMHO this is a violation of the PCI spec.
         * We call pci_set_master here because it does not hurt. */
        pci_set_master(pci);
        return 0;
}

struct via823x_info {
        int revision;
        char *name;
        int type;
};
static const struct via823x_info via823x_cards[] = {
        { VIA_REV_PRE_8233, "VIA 8233-Pre", TYPE_VIA8233 },
        { VIA_REV_8233C, "VIA 8233C", TYPE_VIA8233 },
        { VIA_REV_8233, "VIA 8233", TYPE_VIA8233 },
        { VIA_REV_8233A, "VIA 8233A", TYPE_VIA8233A },
        { VIA_REV_8235, "VIA 8235", TYPE_VIA8233 },
        { VIA_REV_8237, "VIA 8237", TYPE_VIA8233 },
        { VIA_REV_8251, "VIA 8251", TYPE_VIA8233 },
};

/*
 * auto detection of DXS channel supports.
 */

static const struct snd_pci_quirk dxs_allowlist[] = {
        SND_PCI_QUIRK(0x1005, 0x4710, "Avance Logic Mobo", VIA_DXS_ENABLE),
        SND_PCI_QUIRK(0x1019, 0x0996, "ESC Mobo", VIA_DXS_48K),
        SND_PCI_QUIRK(0x1019, 0x0a81, "ECS K7VTA3 v8.0", VIA_DXS_NO_VRA),
        SND_PCI_QUIRK(0x1019, 0x0a85, "ECS L7VMM2", VIA_DXS_NO_VRA),
        SND_PCI_QUIRK_VENDOR(0x1019, "ESC K8", VIA_DXS_SRC),
        SND_PCI_QUIRK(0x1019, 0xaa01, "ESC K8T890-A", VIA_DXS_SRC),
        SND_PCI_QUIRK(0x1025, 0x0033, "Acer Inspire 1353LM", VIA_DXS_NO_VRA),
        SND_PCI_QUIRK(0x1025, 0x0046, "Acer Aspire 1524 WLMi", VIA_DXS_SRC),
        SND_PCI_QUIRK_VENDOR(0x1043, "ASUS A7/A8", VIA_DXS_NO_VRA),
        SND_PCI_QUIRK_VENDOR(0x1071, "Diverse Notebook", VIA_DXS_NO_VRA),
        SND_PCI_QUIRK(0x10cf, 0x118e, "FSC Laptop", VIA_DXS_ENABLE),
        SND_PCI_QUIRK_VENDOR(0x1106, "ASRock", VIA_DXS_SRC),
        SND_PCI_QUIRK(0x1297, 0xa231, "Shuttle AK31v2", VIA_DXS_SRC),
        SND_PCI_QUIRK(0x1297, 0xa232, "Shuttle", VIA_DXS_SRC),
        SND_PCI_QUIRK(0x1297, 0xc160, "Shuttle Sk41G", VIA_DXS_SRC),
        SND_PCI_QUIRK(0x1458, 0xa002, "Gigabyte GA-7VAXP", VIA_DXS_ENABLE),
        SND_PCI_QUIRK(0x1462, 0x3800, "MSI KT266", VIA_DXS_ENABLE),
        SND_PCI_QUIRK(0x1462, 0x7120, "MSI KT4V", VIA_DXS_ENABLE),
        SND_PCI_QUIRK(0x1462, 0x7142, "MSI K8MM-V", VIA_DXS_ENABLE),
        SND_PCI_QUIRK_VENDOR(0x1462, "MSI Mobo", VIA_DXS_SRC),
        SND_PCI_QUIRK(0x147b, 0x1401, "ABIT KD7(-RAID)", VIA_DXS_ENABLE),
        SND_PCI_QUIRK(0x147b, 0x1411, "ABIT VA-20", VIA_DXS_ENABLE),
        SND_PCI_QUIRK(0x147b, 0x1413, "ABIT KV8 Pro", VIA_DXS_ENABLE),
        SND_PCI_QUIRK(0x147b, 0x1415, "ABIT AV8", VIA_DXS_NO_VRA),
        SND_PCI_QUIRK(0x14ff, 0x0403, "Twinhead mobo", VIA_DXS_ENABLE),
        SND_PCI_QUIRK(0x14ff, 0x0408, "Twinhead laptop", VIA_DXS_SRC),
        SND_PCI_QUIRK(0x1558, 0x4701, "Clevo D470", VIA_DXS_SRC),
        SND_PCI_QUIRK(0x1584, 0x8120, "Diverse Laptop", VIA_DXS_ENABLE),
        SND_PCI_QUIRK(0x1584, 0x8123, "Targa/Uniwill", VIA_DXS_NO_VRA),
        SND_PCI_QUIRK(0x161f, 0x202b, "Amira Notebook", VIA_DXS_NO_VRA),
        SND_PCI_QUIRK(0x161f, 0x2032, "m680x machines", VIA_DXS_48K),
        SND_PCI_QUIRK(0x1631, 0xe004, "PB EasyNote 3174", VIA_DXS_ENABLE),
        SND_PCI_QUIRK(0x1695, 0x3005, "EPoX EP-8K9A", VIA_DXS_ENABLE),
        SND_PCI_QUIRK_VENDOR(0x1695, "EPoX mobo", VIA_DXS_SRC),
        SND_PCI_QUIRK_VENDOR(0x16f3, "Jetway K8", VIA_DXS_SRC),
        SND_PCI_QUIRK_VENDOR(0x1734, "FSC Laptop", VIA_DXS_SRC),
        SND_PCI_QUIRK(0x1849, 0x3059, "ASRock K7VM2", VIA_DXS_NO_VRA),
        SND_PCI_QUIRK_VENDOR(0x1849, "ASRock mobo", VIA_DXS_SRC),
        SND_PCI_QUIRK(0x1919, 0x200a, "Soltek SL-K8",  VIA_DXS_NO_VRA),
        SND_PCI_QUIRK(0x4005, 0x4710, "MSI K7T266", VIA_DXS_SRC),
        { } /* terminator */
};

static int check_dxs_list(struct pci_dev *pci, int revision)
{
        const struct snd_pci_quirk *w;

        w = snd_pci_quirk_lookup(pci, dxs_allowlist);
        if (w) {
                dev_dbg(&pci->dev, "DXS allow list for %s found\n",
                            snd_pci_quirk_name(w));
                return w->value;
        }

        /* for newer revision, default to DXS_SRC */
        if (revision >= VIA_REV_8235)
                return VIA_DXS_SRC;

        /*
         * not detected, try 48k rate only to be sure.
         */
        dev_info(&pci->dev, "Assuming DXS channels with 48k fixed sample rate.\n");
        dev_info(&pci->dev, "         Please try dxs_support=5 option\n");
        dev_info(&pci->dev, "         and report if it works on your machine.\n");
        dev_info(&pci->dev, "         For more details, read ALSA-Configuration.txt.\n");
        return VIA_DXS_48K;
};

static int snd_via82xx_probe(struct pci_dev *pci,
                             const struct pci_device_id *pci_id)
{
        struct snd_card *card;
        struct via82xx *chip;
        int chip_type = 0, card_type;
        unsigned int i;
        int err;

        err = snd_devm_card_new(&pci->dev, index, id, THIS_MODULE,
                                sizeof(*chip), &card);
        if (err < 0)
                return err;
        chip = card->private_data;

        card_type = pci_id->driver_data;
        switch (card_type) {
        case TYPE_CARD_VIA686:
                strcpy(card->driver, "VIA686A");
                sprintf(card->shortname, "VIA 82C686A/B rev%x", pci->revision);
                chip_type = TYPE_VIA686;
                break;
        case TYPE_CARD_VIA8233:
                chip_type = TYPE_VIA8233;
                sprintf(card->shortname, "VIA 823x rev%x", pci->revision);
                for (i = 0; i < ARRAY_SIZE(via823x_cards); i++) {
                        if (pci->revision == via823x_cards[i].revision) {
                                chip_type = via823x_cards[i].type;
                                strcpy(card->shortname, via823x_cards[i].name);
                                break;
                        }
                }
                if (chip_type != TYPE_VIA8233A) {
                        if (dxs_support == VIA_DXS_AUTO)
                                dxs_support = check_dxs_list(pci, pci->revision);
                        /* force to use VIA8233 or 8233A model according to
                         * dxs_support module option
                         */
                        if (dxs_support == VIA_DXS_DISABLE)
                                chip_type = TYPE_VIA8233A;
                        else
                                chip_type = TYPE_VIA8233;
                }
                if (chip_type == TYPE_VIA8233A)
                        strcpy(card->driver, "VIA8233A");
                else if (pci->revision >= VIA_REV_8237)
                        strcpy(card->driver, "VIA8237"); /* no slog assignment */
                else
                        strcpy(card->driver, "VIA8233");
                break;
        default:
                dev_err(card->dev, "invalid card type %d\n", card_type);
                return -EINVAL;
        }
                
        err = snd_via82xx_create(card, pci, chip_type, pci->revision,
                                 ac97_clock);
        if (err < 0)
                return err;
        err = snd_via82xx_mixer_new(chip, ac97_quirk);
        if (err < 0)
                return err;

        if (chip_type == TYPE_VIA686) {
                err = snd_via686_pcm_new(chip);
                if (err < 0)
                        return err;
                err = snd_via686_init_misc(chip);
                if (err < 0)
                        return err;
        } else {
                if (chip_type == TYPE_VIA8233A) {
                        err = snd_via8233a_pcm_new(chip);
                        if (err < 0)
                                return err;
                        // chip->dxs_fixed = 1; /* FIXME: use 48k for DXS #3? */
                } else {
                        err = snd_via8233_pcm_new(chip);
                        if (err < 0)
                                return err;
                        if (dxs_support == VIA_DXS_48K)
                                chip->dxs_fixed = 1;
                        else if (dxs_support == VIA_DXS_NO_VRA)
                                chip->no_vra = 1;
                        else if (dxs_support == VIA_DXS_SRC) {
                                chip->no_vra = 1;
                                chip->dxs_src = 1;
                        }
                }
                err = snd_via8233_init_misc(chip);
                if (err < 0)
                        return err;
        }

        /* disable interrupts */
        for (i = 0; i < chip->num_devs; i++)
                snd_via82xx_channel_reset(chip, &chip->devs[i]);

        snprintf(card->longname, sizeof(card->longname),
                 "%s with %s at %#lx, irq %d", card->shortname,
                 snd_ac97_get_short_name(chip->ac97), chip->port, chip->irq);

        snd_via82xx_proc_init(chip);

        err = snd_card_register(card);
        if (err < 0)
                return err;
        pci_set_drvdata(pci, card);
        return 0;
}

static struct pci_driver via82xx_driver = {
        .name = KBUILD_MODNAME,
        .id_table = snd_via82xx_ids,
        .probe = snd_via82xx_probe,
        .driver = {
                .pm = SND_VIA82XX_PM_OPS,
        },
};

module_pci_driver(via82xx_driver);