Logo Search packages:      
Sourcecode: alsa-driver version File versions

sonicvibes.c

/*
 *  Driver for S3 SonicVibes soundcard
 *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
 *
 *  BUGS:
 *    It looks like 86c617 rev 3 doesn't supports DDMA buffers above 16MB?
 *    Driver sometimes hangs... Nobody knows why at this moment...
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

#include <sound/driver.h>
#include <linux/delay.h>
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/pci.h>
#include <linux/slab.h>
#include <linux/gameport.h>
#include <linux/moduleparam.h>

#include <sound/core.h>
#include <sound/pcm.h>
#include <sound/info.h>
#include <sound/control.h>
#include <sound/mpu401.h>
#include <sound/opl3.h>
#include <sound/initval.h>

#include <asm/io.h>

MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
MODULE_DESCRIPTION("S3 SonicVibes PCI");
MODULE_LICENSE("GPL");
MODULE_SUPPORTED_DEVICE("{{S3,SonicVibes PCI}}");

#ifndef PCI_VENDOR_ID_S3
#define PCI_VENDOR_ID_S3             0x5333
#endif
#ifndef PCI_DEVICE_ID_S3_SONICVIBES
#define PCI_DEVICE_ID_S3_SONICVIBES  0xca00
#endif

static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;    /* Index 0-MAX */
static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;     /* ID for this card */
static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;  /* Enable this card */
static int reverb[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 0};
static int mge[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 0};
static unsigned int dmaio = 0x7a00; /* DDMA i/o address */

module_param_array(index, int, NULL, 0444);
MODULE_PARM_DESC(index, "Index value for S3 SonicVibes soundcard.");
module_param_array(id, charp, NULL, 0444);
MODULE_PARM_DESC(id, "ID string for S3 SonicVibes soundcard.");
module_param_array(enable, bool, NULL, 0444);
MODULE_PARM_DESC(enable, "Enable S3 SonicVibes soundcard.");
module_param_array(reverb, bool, NULL, 0444);
MODULE_PARM_DESC(reverb, "Enable reverb (SRAM is present) for S3 SonicVibes soundcard.");
module_param_array(mge, bool, NULL, 0444);
MODULE_PARM_DESC(mge, "MIC Gain Enable for S3 SonicVibes soundcard.");
module_param(dmaio, uint, 0444);
MODULE_PARM_DESC(dmaio, "DDMA i/o base address for S3 SonicVibes soundcard.");

/*
 * Enhanced port direct registers
 */

#define SV_REG(sonic, x) ((sonic)->enh_port + SV_REG_##x)

#define SV_REG_CONTROL  0x00  /* R/W: CODEC/Mixer control register */
#define   SV_ENHANCED     0x01      /* audio mode select - enhanced mode */
#define   SV_TEST   0x02      /* test bit */
#define   SV_REVERB       0x04      /* reverb enable */
#define   SV_WAVETABLE    0x08      /* wavetable active / FM active if not set */
#define   SV_INTA   0x20      /* INTA driving - should be always 1 */
#define   SV_RESET        0x80      /* reset chip */
#define SV_REG_IRQMASK  0x01  /* R/W: CODEC/Mixer interrupt mask register */
#define   SV_DMAA_MASK    0x01      /* mask DMA-A interrupt */
#define   SV_DMAC_MASK    0x04      /* mask DMA-C interrupt */
#define   SV_SPEC_MASK    0x08      /* special interrupt mask - should be always masked */
#define   SV_UD_MASK      0x40      /* Up/Down button interrupt mask */
#define   SV_MIDI_MASK    0x80      /* mask MIDI interrupt */
#define SV_REG_STATUS   0x02  /* R/O: CODEC/Mixer status register */
#define   SV_DMAA_IRQ     0x01      /* DMA-A interrupt */
#define   SV_DMAC_IRQ     0x04      /* DMA-C interrupt */
#define   SV_SPEC_IRQ     0x08      /* special interrupt */
#define   SV_UD_IRQ       0x40      /* Up/Down interrupt */
#define   SV_MIDI_IRQ     0x80      /* MIDI interrupt */
#define SV_REG_INDEX    0x04  /* R/W: CODEC/Mixer index address register */
#define   SV_MCE          0x40      /* mode change enable */
#define   SV_TRD    0x80      /* DMA transfer request disabled */
#define SV_REG_DATA     0x05  /* R/W: CODEC/Mixer index data register */

/*
 * Enhanced port indirect registers
 */

#define SV_IREG_LEFT_ADC      0x00  /* Left ADC Input Control */
#define SV_IREG_RIGHT_ADC     0x01  /* Right ADC Input Control */
#define SV_IREG_LEFT_AUX1     0x02  /* Left AUX1 Input Control */
#define SV_IREG_RIGHT_AUX1    0x03  /* Right AUX1 Input Control */
#define SV_IREG_LEFT_CD       0x04  /* Left CD Input Control */
#define SV_IREG_RIGHT_CD      0x05  /* Right CD Input Control */
#define SV_IREG_LEFT_LINE     0x06  /* Left Line Input Control */
#define SV_IREG_RIGHT_LINE    0x07  /* Right Line Input Control */
#define SV_IREG_MIC           0x08  /* MIC Input Control */
#define SV_IREG_GAME_PORT     0x09  /* Game Port Control */
#define SV_IREG_LEFT_SYNTH    0x0a  /* Left Synth Input Control */
#define SV_IREG_RIGHT_SYNTH   0x0b  /* Right Synth Input Control */
#define SV_IREG_LEFT_AUX2     0x0c  /* Left AUX2 Input Control */
#define SV_IREG_RIGHT_AUX2    0x0d  /* Right AUX2 Input Control */
#define SV_IREG_LEFT_ANALOG   0x0e  /* Left Analog Mixer Output Control */
#define SV_IREG_RIGHT_ANALOG  0x0f  /* Right Analog Mixer Output Control */
#define SV_IREG_LEFT_PCM      0x10  /* Left PCM Input Control */
#define SV_IREG_RIGHT_PCM     0x11  /* Right PCM Input Control */
#define SV_IREG_DMA_DATA_FMT  0x12  /* DMA Data Format */
#define SV_IREG_PC_ENABLE     0x13  /* Playback/Capture Enable Register */
#define SV_IREG_UD_BUTTON     0x14  /* Up/Down Button Register */
#define SV_IREG_REVISION      0x15  /* Revision */
#define SV_IREG_ADC_OUTPUT_CTRL     0x16  /* ADC Output Control */
#define SV_IREG_DMA_A_UPPER   0x18  /* DMA A Upper Base Count */
#define SV_IREG_DMA_A_LOWER   0x19  /* DMA A Lower Base Count */
#define SV_IREG_DMA_C_UPPER   0x1c  /* DMA C Upper Base Count */
#define SV_IREG_DMA_C_LOWER   0x1d  /* DMA C Lower Base Count */
#define SV_IREG_PCM_RATE_LOW  0x1e  /* PCM Sampling Rate Low Byte */
#define SV_IREG_PCM_RATE_HIGH 0x1f  /* PCM Sampling Rate High Byte */
#define SV_IREG_SYNTH_RATE_LOW      0x20  /* Synthesizer Sampling Rate Low Byte */
#define SV_IREG_SYNTH_RATE_HIGH 0x21      /* Synthesizer Sampling Rate High Byte */
#define SV_IREG_ADC_CLOCK     0x22  /* ADC Clock Source Selection */
#define SV_IREG_ADC_ALT_RATE  0x23  /* ADC Alternative Sampling Rate Selection */
#define SV_IREG_ADC_PLL_M     0x24  /* ADC PLL M Register */
#define SV_IREG_ADC_PLL_N     0x25  /* ADC PLL N Register */
#define SV_IREG_SYNTH_PLL_M   0x26  /* Synthesizer PLL M Register */
#define SV_IREG_SYNTH_PLL_N   0x27  /* Synthesizer PLL N Register */
#define SV_IREG_MPU401        0x2a  /* MPU-401 UART Operation */
#define SV_IREG_DRIVE_CTRL    0x2b  /* Drive Control */
#define SV_IREG_SRS_SPACE     0x2c  /* SRS Space Control */
#define SV_IREG_SRS_CENTER    0x2d  /* SRS Center Control */
#define SV_IREG_WAVE_SOURCE   0x2e  /* Wavetable Sample Source Select */
#define SV_IREG_ANALOG_POWER  0x30  /* Analog Power Down Control */
#define SV_IREG_DIGITAL_POWER 0x31  /* Digital Power Down Control */

#define SV_IREG_ADC_PLL       SV_IREG_ADC_PLL_M
#define SV_IREG_SYNTH_PLL     SV_IREG_SYNTH_PLL_M

/*
 *  DMA registers
 */

#define SV_DMA_ADDR0          0x00
#define SV_DMA_ADDR1          0x01
#define SV_DMA_ADDR2          0x02
#define SV_DMA_ADDR3          0x03
#define SV_DMA_COUNT0         0x04
#define SV_DMA_COUNT1         0x05
#define SV_DMA_COUNT2         0x06
#define SV_DMA_MODE           0x0b
#define SV_DMA_RESET          0x0d
#define SV_DMA_MASK           0x0f

/*
 *  Record sources
 */

#define SV_RECSRC_RESERVED    (0x00<<5)
#define SV_RECSRC_CD          (0x01<<5)
#define SV_RECSRC_DAC         (0x02<<5)
#define SV_RECSRC_AUX2        (0x03<<5)
#define SV_RECSRC_LINE        (0x04<<5)
#define SV_RECSRC_AUX1        (0x05<<5)
#define SV_RECSRC_MIC         (0x06<<5)
#define SV_RECSRC_OUT         (0x07<<5)

/*
 *  constants
 */

#define SV_FULLRATE           48000
#define SV_REFFREQUENCY       24576000
#define SV_ADCMULT            512

#define SV_MODE_PLAY          1
#define SV_MODE_CAPTURE       2

/*

 */

typedef struct _snd_sonicvibes sonicvibes_t;

struct _snd_sonicvibes {
      unsigned long dma1size;
      unsigned long dma2size;
      int irq;

      unsigned long sb_port;
      unsigned long enh_port;
      unsigned long synth_port;
      unsigned long midi_port;
      unsigned long game_port;
      unsigned int dmaa_port;
      struct resource *res_dmaa;
      unsigned int dmac_port;
      struct resource *res_dmac;

      unsigned char enable;
      unsigned char irqmask;
      unsigned char revision;
      unsigned char format;
      unsigned char srs_space;
      unsigned char srs_center;
      unsigned char mpu_switch;
      unsigned char wave_source;

      unsigned int mode;

      struct pci_dev *pci;
      snd_card_t *card;
      snd_pcm_t *pcm;
      snd_pcm_substream_t *playback_substream;
      snd_pcm_substream_t *capture_substream;
      snd_rawmidi_t *rmidi;
      snd_hwdep_t *fmsynth;   /* S3FM */

      spinlock_t reg_lock;

      unsigned int p_dma_size;
      unsigned int c_dma_size;

      snd_kcontrol_t *master_mute;
      snd_kcontrol_t *master_volume;

#if defined(CONFIG_GAMEPORT) || (defined(MODULE) && defined(CONFIG_GAMEPORT_MODULE))
      struct gameport gameport;
#endif
};

static struct pci_device_id snd_sonic_ids[] = {
      { 0x5333, 0xca00, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0, },
        { 0, }
};

MODULE_DEVICE_TABLE(pci, snd_sonic_ids);

static ratden_t sonicvibes_adc_clock = {
      .num_min = 4000 * 65536,
      .num_max = 48000UL * 65536,
      .num_step = 1,
      .den = 65536,
};
static snd_pcm_hw_constraint_ratdens_t snd_sonicvibes_hw_constraints_adc_clock = {
      .nrats = 1,
      .rats = &sonicvibes_adc_clock,
};

/*
 *  common I/O routines
 */

static inline void snd_sonicvibes_setdmaa(sonicvibes_t * sonic,
                                unsigned int addr,
                                unsigned int count)
{
      count--;
      outl(addr, sonic->dmaa_port + SV_DMA_ADDR0);
      outl(count, sonic->dmaa_port + SV_DMA_COUNT0);
      outb(0x18, sonic->dmaa_port + SV_DMA_MODE);
#if 0
      printk("program dmaa: addr = 0x%x, paddr = 0x%x\n", addr, inl(sonic->dmaa_port + SV_DMA_ADDR0));
#endif
}

static inline void snd_sonicvibes_setdmac(sonicvibes_t * sonic,
                                unsigned int addr,
                                unsigned int count)
{
      /* note: dmac is working in word mode!!! */
      count >>= 1;
      count--;
      outl(addr, sonic->dmac_port + SV_DMA_ADDR0);
      outl(count, sonic->dmac_port + SV_DMA_COUNT0);
      outb(0x14, sonic->dmac_port + SV_DMA_MODE);
#if 0
      printk("program dmac: addr = 0x%x, paddr = 0x%x\n", addr, inl(sonic->dmac_port + SV_DMA_ADDR0));
#endif
}

static inline unsigned int snd_sonicvibes_getdmaa(sonicvibes_t * sonic)
{
      return (inl(sonic->dmaa_port + SV_DMA_COUNT0) & 0xffffff) + 1;
}

static inline unsigned int snd_sonicvibes_getdmac(sonicvibes_t * sonic)
{
      /* note: dmac is working in word mode!!! */
      return ((inl(sonic->dmac_port + SV_DMA_COUNT0) & 0xffffff) + 1) << 1;
}

static void snd_sonicvibes_out1(sonicvibes_t * sonic,
                        unsigned char reg,
                        unsigned char value)
{
      outb(reg, SV_REG(sonic, INDEX));
      udelay(10);
      outb(value, SV_REG(sonic, DATA));
      udelay(10);
}

static void snd_sonicvibes_out(sonicvibes_t * sonic,
                         unsigned char reg,
                         unsigned char value)
{
      unsigned long flags;

      spin_lock_irqsave(&sonic->reg_lock, flags);
      outb(reg, SV_REG(sonic, INDEX));
      udelay(10);
      outb(value, SV_REG(sonic, DATA));
      udelay(10);
      spin_unlock_irqrestore(&sonic->reg_lock, flags);
}

static unsigned char snd_sonicvibes_in1(sonicvibes_t * sonic, unsigned char reg)
{
      unsigned char value;

      outb(reg, SV_REG(sonic, INDEX));
      udelay(10);
      value = inb(SV_REG(sonic, DATA));
      udelay(10);
      return value;
}

static unsigned char snd_sonicvibes_in(sonicvibes_t * sonic, unsigned char reg)
{
      unsigned long flags;
      unsigned char value;

      spin_lock_irqsave(&sonic->reg_lock, flags);
      outb(reg, SV_REG(sonic, INDEX));
      udelay(10);
      value = inb(SV_REG(sonic, DATA));
      udelay(10);
      spin_unlock_irqrestore(&sonic->reg_lock, flags);
      return value;
}

#if 0
static void snd_sonicvibes_debug(sonicvibes_t * sonic)
{
      printk("SV REGS:          INDEX = 0x%02x  ", inb(SV_REG(sonic, INDEX)));
      printk("                 STATUS = 0x%02x\n", inb(SV_REG(sonic, STATUS)));
      printk("  0x00: left input      = 0x%02x  ", snd_sonicvibes_in(sonic, 0x00));
      printk("  0x20: synth rate low  = 0x%02x\n", snd_sonicvibes_in(sonic, 0x20));
      printk("  0x01: right input     = 0x%02x  ", snd_sonicvibes_in(sonic, 0x01));
      printk("  0x21: synth rate high = 0x%02x\n", snd_sonicvibes_in(sonic, 0x21));
      printk("  0x02: left AUX1       = 0x%02x  ", snd_sonicvibes_in(sonic, 0x02));
      printk("  0x22: ADC clock       = 0x%02x\n", snd_sonicvibes_in(sonic, 0x22));
      printk("  0x03: right AUX1      = 0x%02x  ", snd_sonicvibes_in(sonic, 0x03));
      printk("  0x23: ADC alt rate    = 0x%02x\n", snd_sonicvibes_in(sonic, 0x23));
      printk("  0x04: left CD         = 0x%02x  ", snd_sonicvibes_in(sonic, 0x04));
      printk("  0x24: ADC pll M       = 0x%02x\n", snd_sonicvibes_in(sonic, 0x24));
      printk("  0x05: right CD        = 0x%02x  ", snd_sonicvibes_in(sonic, 0x05));
      printk("  0x25: ADC pll N       = 0x%02x\n", snd_sonicvibes_in(sonic, 0x25));
      printk("  0x06: left line       = 0x%02x  ", snd_sonicvibes_in(sonic, 0x06));
      printk("  0x26: Synth pll M     = 0x%02x\n", snd_sonicvibes_in(sonic, 0x26));
      printk("  0x07: right line      = 0x%02x  ", snd_sonicvibes_in(sonic, 0x07));
      printk("  0x27: Synth pll N     = 0x%02x\n", snd_sonicvibes_in(sonic, 0x27));
      printk("  0x08: MIC             = 0x%02x  ", snd_sonicvibes_in(sonic, 0x08));
      printk("  0x28: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x28));
      printk("  0x09: Game port       = 0x%02x  ", snd_sonicvibes_in(sonic, 0x09));
      printk("  0x29: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x29));
      printk("  0x0a: left synth      = 0x%02x  ", snd_sonicvibes_in(sonic, 0x0a));
      printk("  0x2a: MPU401          = 0x%02x\n", snd_sonicvibes_in(sonic, 0x2a));
      printk("  0x0b: right synth     = 0x%02x  ", snd_sonicvibes_in(sonic, 0x0b));
      printk("  0x2b: drive ctrl      = 0x%02x\n", snd_sonicvibes_in(sonic, 0x2b));
      printk("  0x0c: left AUX2       = 0x%02x  ", snd_sonicvibes_in(sonic, 0x0c));
      printk("  0x2c: SRS space       = 0x%02x\n", snd_sonicvibes_in(sonic, 0x2c));
      printk("  0x0d: right AUX2      = 0x%02x  ", snd_sonicvibes_in(sonic, 0x0d));
      printk("  0x2d: SRS center      = 0x%02x\n", snd_sonicvibes_in(sonic, 0x2d));
      printk("  0x0e: left analog     = 0x%02x  ", snd_sonicvibes_in(sonic, 0x0e));
      printk("  0x2e: wave source     = 0x%02x\n", snd_sonicvibes_in(sonic, 0x2e));
      printk("  0x0f: right analog    = 0x%02x  ", snd_sonicvibes_in(sonic, 0x0f));
      printk("  0x2f: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x2f));
      printk("  0x10: left PCM        = 0x%02x  ", snd_sonicvibes_in(sonic, 0x10));
      printk("  0x30: analog power    = 0x%02x\n", snd_sonicvibes_in(sonic, 0x30));
      printk("  0x11: right PCM       = 0x%02x  ", snd_sonicvibes_in(sonic, 0x11));
      printk("  0x31: analog power    = 0x%02x\n", snd_sonicvibes_in(sonic, 0x31));
      printk("  0x12: DMA data format = 0x%02x  ", snd_sonicvibes_in(sonic, 0x12));
      printk("  0x32: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x32));
      printk("  0x13: P/C enable      = 0x%02x  ", snd_sonicvibes_in(sonic, 0x13));
      printk("  0x33: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x33));
      printk("  0x14: U/D button      = 0x%02x  ", snd_sonicvibes_in(sonic, 0x14));
      printk("  0x34: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x34));
      printk("  0x15: revision        = 0x%02x  ", snd_sonicvibes_in(sonic, 0x15));
      printk("  0x35: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x35));
      printk("  0x16: ADC output ctrl = 0x%02x  ", snd_sonicvibes_in(sonic, 0x16));
      printk("  0x36: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x36));
      printk("  0x17: ---             = 0x%02x  ", snd_sonicvibes_in(sonic, 0x17));
      printk("  0x37: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x37));
      printk("  0x18: DMA A upper cnt = 0x%02x  ", snd_sonicvibes_in(sonic, 0x18));
      printk("  0x38: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x38));
      printk("  0x19: DMA A lower cnt = 0x%02x  ", snd_sonicvibes_in(sonic, 0x19));
      printk("  0x39: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x39));
      printk("  0x1a: ---             = 0x%02x  ", snd_sonicvibes_in(sonic, 0x1a));
      printk("  0x3a: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x3a));
      printk("  0x1b: ---             = 0x%02x  ", snd_sonicvibes_in(sonic, 0x1b));
      printk("  0x3b: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x3b));
      printk("  0x1c: DMA C upper cnt = 0x%02x  ", snd_sonicvibes_in(sonic, 0x1c));
      printk("  0x3c: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x3c));
      printk("  0x1d: DMA C upper cnt = 0x%02x  ", snd_sonicvibes_in(sonic, 0x1d));
      printk("  0x3d: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x3d));
      printk("  0x1e: PCM rate low    = 0x%02x  ", snd_sonicvibes_in(sonic, 0x1e));
      printk("  0x3e: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x3e));
      printk("  0x1f: PCM rate high   = 0x%02x  ", snd_sonicvibes_in(sonic, 0x1f));
      printk("  0x3f: ---             = 0x%02x\n", snd_sonicvibes_in(sonic, 0x3f));
}

#endif

static void snd_sonicvibes_setfmt(sonicvibes_t * sonic,
                                  unsigned char mask,
                                  unsigned char value)
{
      unsigned long flags;

      spin_lock_irqsave(&sonic->reg_lock, flags);
      outb(SV_MCE | SV_IREG_DMA_DATA_FMT, SV_REG(sonic, INDEX));
      if (mask) {
            sonic->format = inb(SV_REG(sonic, DATA));
            udelay(10);
      }
      sonic->format = (sonic->format & mask) | value;
      outb(sonic->format, SV_REG(sonic, DATA));
      udelay(10);
      outb(0, SV_REG(sonic, INDEX));
      udelay(10);
      spin_unlock_irqrestore(&sonic->reg_lock, flags);
}

static void snd_sonicvibes_pll(unsigned int rate,
                         unsigned int *res_r,
                         unsigned int *res_m,
                         unsigned int *res_n)
{
      unsigned int r, m = 0, n = 0;
      unsigned int xm, xn, xr, xd, metric = ~0U;

      if (rate < 625000 / SV_ADCMULT)
            rate = 625000 / SV_ADCMULT;
      if (rate > 150000000 / SV_ADCMULT)
            rate = 150000000 / SV_ADCMULT;
      /* slight violation of specs, needed for continuous sampling rates */
      for (r = 0; rate < 75000000 / SV_ADCMULT; r += 0x20, rate <<= 1);
      for (xn = 3; xn < 33; xn++)   /* 35 */
            for (xm = 3; xm < 257; xm++) {
                  xr = ((SV_REFFREQUENCY / SV_ADCMULT) * xm) / xn;
                  if (xr >= rate)
                        xd = xr - rate;
                  else
                        xd = rate - xr;
                  if (xd < metric) {
                        metric = xd;
                        m = xm - 2;
                        n = xn - 2;
                  }
            }
      *res_r = r;
      *res_m = m;
      *res_n = n;
#if 0
      printk("metric = %i, xm = %i, xn = %i\n", metric, xm, xn);
      printk("pll: m = 0x%x, r = 0x%x, n = 0x%x\n", reg, m, r, n);
#endif
}

static void snd_sonicvibes_setpll(sonicvibes_t * sonic,
                                  unsigned char reg,
                                  unsigned int rate)
{
      unsigned long flags;
      unsigned int r, m, n;

      snd_sonicvibes_pll(rate, &r, &m, &n);
      if (sonic != NULL) {
            spin_lock_irqsave(&sonic->reg_lock, flags);
            snd_sonicvibes_out1(sonic, reg, m);
            snd_sonicvibes_out1(sonic, reg + 1, r | n);
            spin_unlock_irqrestore(&sonic->reg_lock, flags);
      }
}

static void snd_sonicvibes_set_adc_rate(sonicvibes_t * sonic, unsigned int rate)
{
      unsigned long flags;
      unsigned int div;
      unsigned char clock;

      div = 48000 / rate;
      if (div > 8)
            div = 8;
      if ((48000 / div) == rate) {  /* use the alternate clock */
            clock = 0x10;
      } else {                /* use the PLL source */
            clock = 0x00;
            snd_sonicvibes_setpll(sonic, SV_IREG_ADC_PLL, rate);
      }
      spin_lock_irqsave(&sonic->reg_lock, flags);
      snd_sonicvibes_out1(sonic, SV_IREG_ADC_ALT_RATE, (div - 1) << 4);
      snd_sonicvibes_out1(sonic, SV_IREG_ADC_CLOCK, clock);
      spin_unlock_irqrestore(&sonic->reg_lock, flags);
}

static int snd_sonicvibes_hw_constraint_dac_rate(snd_pcm_hw_params_t *params,
                                     snd_pcm_hw_rule_t *rule)
{
      unsigned int rate, div, r, m, n;

      if (hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE)->min == 
          hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE)->max) {
            rate = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE)->min;
            div = 48000 / rate;
            if (div > 8)
                  div = 8;
            if ((48000 / div) == rate) {
                  params->rate_num = rate;
                  params->rate_den = 1;
            } else {
                  snd_sonicvibes_pll(rate, &r, &m, &n);
                  snd_assert((SV_REFFREQUENCY % 16) == 0, return -EINVAL);
                  snd_assert((SV_ADCMULT % 512) == 0, return -EINVAL);
                  params->rate_num = (SV_REFFREQUENCY/16) * (n+2) * r;
                  params->rate_den = (SV_ADCMULT/512) * (m+2);
            }
      }
      return 0;
}

static void snd_sonicvibes_set_dac_rate(sonicvibes_t * sonic, unsigned int rate)
{
      unsigned int div;
      unsigned long flags;

      div = (rate * 65536 + SV_FULLRATE / 2) / SV_FULLRATE;
      if (div > 65535)
            div = 65535;
      spin_lock_irqsave(&sonic->reg_lock, flags);
      snd_sonicvibes_out1(sonic, SV_IREG_PCM_RATE_HIGH, div >> 8);
      snd_sonicvibes_out1(sonic, SV_IREG_PCM_RATE_LOW, div);
      spin_unlock_irqrestore(&sonic->reg_lock, flags);
}

static int snd_sonicvibes_trigger(sonicvibes_t * sonic, int what, int cmd)
{
      int result = 0;

      spin_lock(&sonic->reg_lock);
      if (cmd == SNDRV_PCM_TRIGGER_START) {
            if (!(sonic->enable & what)) {
                  sonic->enable |= what;
                  snd_sonicvibes_out1(sonic, SV_IREG_PC_ENABLE, sonic->enable);
            }
      } else if (cmd == SNDRV_PCM_TRIGGER_STOP) {
            if (sonic->enable & what) {
                  sonic->enable &= ~what;
                  snd_sonicvibes_out1(sonic, SV_IREG_PC_ENABLE, sonic->enable);
            }
      } else {
            result = -EINVAL;
      }
      spin_unlock(&sonic->reg_lock);
      return result;
}

static irqreturn_t snd_sonicvibes_interrupt(int irq, void *dev_id, struct pt_regs *regs)
{
      sonicvibes_t *sonic = dev_id;
      unsigned char status;

      status = inb(SV_REG(sonic, STATUS));
      if (!(status & (SV_DMAA_IRQ | SV_DMAC_IRQ | SV_MIDI_IRQ)))
            return IRQ_NONE;
      if (status == 0xff) {   /* failure */
            outb(sonic->irqmask = ~0, SV_REG(sonic, IRQMASK));
            snd_printk("IRQ failure - interrupts disabled!!\n");
            return IRQ_HANDLED;
      }
      if (sonic->pcm) {
            if (status & SV_DMAA_IRQ)
                  snd_pcm_period_elapsed(sonic->playback_substream);
            if (status & SV_DMAC_IRQ)
                  snd_pcm_period_elapsed(sonic->capture_substream);
      }
      if (sonic->rmidi) {
            if (status & SV_MIDI_IRQ)
                  snd_mpu401_uart_interrupt(irq, sonic->rmidi->private_data, regs);
      }
      if (status & SV_UD_IRQ) {
            unsigned char udreg;
            int vol, oleft, oright, mleft, mright;

            spin_lock(&sonic->reg_lock);
            udreg = snd_sonicvibes_in1(sonic, SV_IREG_UD_BUTTON);
            vol = udreg & 0x3f;
            if (!(udreg & 0x40))
                  vol = -vol;
            oleft = mleft = snd_sonicvibes_in1(sonic, SV_IREG_LEFT_ANALOG);
            oright = mright = snd_sonicvibes_in1(sonic, SV_IREG_RIGHT_ANALOG);
            oleft &= 0x1f;
            oright &= 0x1f;
            oleft += vol;
            if (oleft < 0)
                  oleft = 0;
            if (oleft > 0x1f)
                  oleft = 0x1f;
            oright += vol;
            if (oright < 0)
                  oright = 0;
            if (oright > 0x1f)
                  oright = 0x1f;
            if (udreg & 0x80) {
                  mleft ^= 0x80;
                  mright ^= 0x80;
            }
            oleft |= mleft & 0x80;
            oright |= mright & 0x80;
            snd_sonicvibes_out1(sonic, SV_IREG_LEFT_ANALOG, oleft);
            snd_sonicvibes_out1(sonic, SV_IREG_RIGHT_ANALOG, oright);
            spin_unlock(&sonic->reg_lock);
            snd_ctl_notify(sonic->card, SNDRV_CTL_EVENT_MASK_VALUE, &sonic->master_mute->id);
            snd_ctl_notify(sonic->card, SNDRV_CTL_EVENT_MASK_VALUE, &sonic->master_volume->id);
      }
      return IRQ_HANDLED;
}

/*
 *  PCM part
 */

static int snd_sonicvibes_playback_trigger(snd_pcm_substream_t * substream,
                                 int cmd)
{
      sonicvibes_t *sonic = snd_pcm_substream_chip(substream);
      return snd_sonicvibes_trigger(sonic, 1, cmd);
}

static int snd_sonicvibes_capture_trigger(snd_pcm_substream_t * substream,
                                int cmd)
{
      sonicvibes_t *sonic = snd_pcm_substream_chip(substream);
      return snd_sonicvibes_trigger(sonic, 2, cmd);
}

static int snd_sonicvibes_hw_params(snd_pcm_substream_t * substream,
                            snd_pcm_hw_params_t * hw_params)
{
      return snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(hw_params));
}

static int snd_sonicvibes_hw_free(snd_pcm_substream_t * substream)
{
      return snd_pcm_lib_free_pages(substream);
}

static int snd_sonicvibes_playback_prepare(snd_pcm_substream_t * substream)
{
      sonicvibes_t *sonic = snd_pcm_substream_chip(substream);
      snd_pcm_runtime_t *runtime = substream->runtime;
      unsigned char fmt = 0;
      unsigned int size = snd_pcm_lib_buffer_bytes(substream);
      unsigned int count = snd_pcm_lib_period_bytes(substream);

      sonic->p_dma_size = size;
      count--;
      if (runtime->channels > 1)
            fmt |= 1;
      if (snd_pcm_format_width(runtime->format) == 16)
            fmt |= 2;
      snd_sonicvibes_setfmt(sonic, ~3, fmt);
      snd_sonicvibes_set_dac_rate(sonic, runtime->rate);
      spin_lock_irq(&sonic->reg_lock);
      snd_sonicvibes_setdmaa(sonic, runtime->dma_addr, size);
      snd_sonicvibes_out1(sonic, SV_IREG_DMA_A_UPPER, count >> 8);
      snd_sonicvibes_out1(sonic, SV_IREG_DMA_A_LOWER, count);
      spin_unlock_irq(&sonic->reg_lock);
      return 0;
}

static int snd_sonicvibes_capture_prepare(snd_pcm_substream_t * substream)
{
      sonicvibes_t *sonic = snd_pcm_substream_chip(substream);
      snd_pcm_runtime_t *runtime = substream->runtime;
      unsigned char fmt = 0;
      unsigned int size = snd_pcm_lib_buffer_bytes(substream);
      unsigned int count = snd_pcm_lib_period_bytes(substream);

      sonic->c_dma_size = size;
      count >>= 1;
      count--;
      if (runtime->channels > 1)
            fmt |= 0x10;
      if (snd_pcm_format_width(runtime->format) == 16)
            fmt |= 0x20;
      snd_sonicvibes_setfmt(sonic, ~0x30, fmt);
      snd_sonicvibes_set_adc_rate(sonic, runtime->rate);
      spin_lock_irq(&sonic->reg_lock);
      snd_sonicvibes_setdmac(sonic, runtime->dma_addr, size);
      snd_sonicvibes_out1(sonic, SV_IREG_DMA_C_UPPER, count >> 8);
      snd_sonicvibes_out1(sonic, SV_IREG_DMA_C_LOWER, count);
      spin_unlock_irq(&sonic->reg_lock);
      return 0;
}

static snd_pcm_uframes_t snd_sonicvibes_playback_pointer(snd_pcm_substream_t * substream)
{
      sonicvibes_t *sonic = snd_pcm_substream_chip(substream);
      size_t ptr;

      if (!(sonic->enable & 1))
            return 0;
      ptr = sonic->p_dma_size - snd_sonicvibes_getdmaa(sonic);
      return bytes_to_frames(substream->runtime, ptr);
}

static snd_pcm_uframes_t snd_sonicvibes_capture_pointer(snd_pcm_substream_t * substream)
{
      sonicvibes_t *sonic = snd_pcm_substream_chip(substream);
      size_t ptr;
      if (!(sonic->enable & 2))
            return 0;
      ptr = sonic->c_dma_size - snd_sonicvibes_getdmac(sonic);
      return bytes_to_frames(substream->runtime, ptr);
}

static snd_pcm_hardware_t snd_sonicvibes_playback =
{
      .info =                 (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
                         SNDRV_PCM_INFO_BLOCK_TRANSFER |
                         SNDRV_PCM_INFO_MMAP_VALID),
      .formats =        SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S16_LE,
      .rates =          SNDRV_PCM_RATE_CONTINUOUS | SNDRV_PCM_RATE_8000_48000,
      .rate_min =       4000,
      .rate_max =       48000,
      .channels_min =         1,
      .channels_max =         2,
      .buffer_bytes_max =     (128*1024),
      .period_bytes_min =     32,
      .period_bytes_max =     (128*1024),
      .periods_min =          1,
      .periods_max =          1024,
      .fifo_size =            0,
};

static snd_pcm_hardware_t snd_sonicvibes_capture =
{
      .info =                 (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
                         SNDRV_PCM_INFO_BLOCK_TRANSFER |
                         SNDRV_PCM_INFO_MMAP_VALID),
      .formats =        SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S16_LE,
      .rates =          SNDRV_PCM_RATE_CONTINUOUS | SNDRV_PCM_RATE_8000_48000,
      .rate_min =       4000,
      .rate_max =       48000,
      .channels_min =         1,
      .channels_max =         2,
      .buffer_bytes_max =     (128*1024),
      .period_bytes_min =     32,
      .period_bytes_max =     (128*1024),
      .periods_min =          1,
      .periods_max =          1024,
      .fifo_size =            0,
};

static int snd_sonicvibes_playback_open(snd_pcm_substream_t * substream)
{
      sonicvibes_t *sonic = snd_pcm_substream_chip(substream);
      snd_pcm_runtime_t *runtime = substream->runtime;

      sonic->mode |= SV_MODE_PLAY;
      sonic->playback_substream = substream;
      runtime->hw = snd_sonicvibes_playback;
      snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE, snd_sonicvibes_hw_constraint_dac_rate, NULL, SNDRV_PCM_HW_PARAM_RATE, -1);
      return 0;
}

static int snd_sonicvibes_capture_open(snd_pcm_substream_t * substream)
{
      sonicvibes_t *sonic = snd_pcm_substream_chip(substream);
      snd_pcm_runtime_t *runtime = substream->runtime;

      sonic->mode |= SV_MODE_CAPTURE;
      sonic->capture_substream = substream;
      runtime->hw = snd_sonicvibes_capture;
      snd_pcm_hw_constraint_ratdens(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
                              &snd_sonicvibes_hw_constraints_adc_clock);
      return 0;
}

static int snd_sonicvibes_playback_close(snd_pcm_substream_t * substream)
{
      sonicvibes_t *sonic = snd_pcm_substream_chip(substream);

      sonic->playback_substream = NULL;
      sonic->mode &= ~SV_MODE_PLAY;
      return 0;
}

static int snd_sonicvibes_capture_close(snd_pcm_substream_t * substream)
{
      sonicvibes_t *sonic = snd_pcm_substream_chip(substream);

      sonic->capture_substream = NULL;
      sonic->mode &= ~SV_MODE_CAPTURE;
      return 0;
}

static snd_pcm_ops_t snd_sonicvibes_playback_ops = {
      .open =           snd_sonicvibes_playback_open,
      .close =    snd_sonicvibes_playback_close,
      .ioctl =    snd_pcm_lib_ioctl,
      .hw_params =      snd_sonicvibes_hw_params,
      .hw_free =  snd_sonicvibes_hw_free,
      .prepare =  snd_sonicvibes_playback_prepare,
      .trigger =  snd_sonicvibes_playback_trigger,
      .pointer =  snd_sonicvibes_playback_pointer,
};

static snd_pcm_ops_t snd_sonicvibes_capture_ops = {
      .open =           snd_sonicvibes_capture_open,
      .close =    snd_sonicvibes_capture_close,
      .ioctl =    snd_pcm_lib_ioctl,
      .hw_params =      snd_sonicvibes_hw_params,
      .hw_free =  snd_sonicvibes_hw_free,
      .prepare =  snd_sonicvibes_capture_prepare,
      .trigger =  snd_sonicvibes_capture_trigger,
      .pointer =  snd_sonicvibes_capture_pointer,
};

static void snd_sonicvibes_pcm_free(snd_pcm_t *pcm)
{
      sonicvibes_t *sonic = pcm->private_data;
      sonic->pcm = NULL;
      snd_pcm_lib_preallocate_free_for_all(pcm);
}

static int __devinit snd_sonicvibes_pcm(sonicvibes_t * sonic, int device, snd_pcm_t ** rpcm)
{
      snd_pcm_t *pcm;
      int err;

      if ((err = snd_pcm_new(sonic->card, "s3_86c617", device, 1, 1, &pcm)) < 0)
            return err;
      snd_assert(pcm != NULL, return -EINVAL);

      snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_sonicvibes_playback_ops);
      snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_sonicvibes_capture_ops);

      pcm->private_data = sonic;
      pcm->private_free = snd_sonicvibes_pcm_free;
      pcm->info_flags = 0;
      strcpy(pcm->name, "S3 SonicVibes");
      sonic->pcm = pcm;

      snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_DEV,
                                    snd_dma_pci_data(sonic->pci), 64*1024, 128*1024);

      if (rpcm)
            *rpcm = pcm;
      return 0;
}

/*
 *  Mixer part
 */

#define SONICVIBES_MUX(xname, xindex) \
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
  .info = snd_sonicvibes_info_mux, \
  .get = snd_sonicvibes_get_mux, .put = snd_sonicvibes_put_mux }

static int snd_sonicvibes_info_mux(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
{
      static char *texts[7] = {
            "CD", "PCM", "Aux1", "Line", "Aux0", "Mic", "Mix"
      };

      uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
      uinfo->count = 2;
      uinfo->value.enumerated.items = 7;
      if (uinfo->value.enumerated.item >= 7)
            uinfo->value.enumerated.item = 6;
      strcpy(uinfo->value.enumerated.name, texts[uinfo->value.enumerated.item]);
      return 0;
}

static int snd_sonicvibes_get_mux(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
{
      sonicvibes_t *sonic = snd_kcontrol_chip(kcontrol);
      
      spin_lock_irq(&sonic->reg_lock);
      ucontrol->value.enumerated.item[0] = ((snd_sonicvibes_in1(sonic, SV_IREG_LEFT_ADC) & SV_RECSRC_OUT) >> 5) - 1;
      ucontrol->value.enumerated.item[1] = ((snd_sonicvibes_in1(sonic, SV_IREG_RIGHT_ADC) & SV_RECSRC_OUT) >> 5) - 1;
      spin_unlock_irq(&sonic->reg_lock);
      return 0;
}

static int snd_sonicvibes_put_mux(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
{
      sonicvibes_t *sonic = snd_kcontrol_chip(kcontrol);
      unsigned short left, right, oval1, oval2;
      int change;
      
      if (ucontrol->value.enumerated.item[0] >= 7 ||
          ucontrol->value.enumerated.item[1] >= 7)
            return -EINVAL;
      left = (ucontrol->value.enumerated.item[0] + 1) << 5;
      right = (ucontrol->value.enumerated.item[1] + 1) << 5;
      spin_lock_irq(&sonic->reg_lock);
      oval1 = snd_sonicvibes_in1(sonic, SV_IREG_LEFT_ADC);
      oval2 = snd_sonicvibes_in1(sonic, SV_IREG_RIGHT_ADC);
      left = (oval1 & ~SV_RECSRC_OUT) | left;
      right = (oval2 & ~SV_RECSRC_OUT) | right;
      change = left != oval1 || right != oval2;
      snd_sonicvibes_out1(sonic, SV_IREG_LEFT_ADC, left);
      snd_sonicvibes_out1(sonic, SV_IREG_RIGHT_ADC, right);
      spin_unlock_irq(&sonic->reg_lock);
      return change;
}

#define SONICVIBES_SINGLE(xname, xindex, reg, shift, mask, invert) \
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
  .info = snd_sonicvibes_info_single, \
  .get = snd_sonicvibes_get_single, .put = snd_sonicvibes_put_single, \
  .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }

static int snd_sonicvibes_info_single(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
{
      int mask = (kcontrol->private_value >> 16) & 0xff;

      uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
      uinfo->count = 1;
      uinfo->value.integer.min = 0;
      uinfo->value.integer.max = mask;
      return 0;
}

static int snd_sonicvibes_get_single(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
{
      sonicvibes_t *sonic = snd_kcontrol_chip(kcontrol);
      int reg = kcontrol->private_value & 0xff;
      int shift = (kcontrol->private_value >> 8) & 0xff;
      int mask = (kcontrol->private_value >> 16) & 0xff;
      int invert = (kcontrol->private_value >> 24) & 0xff;
      
      spin_lock_irq(&sonic->reg_lock);
      ucontrol->value.integer.value[0] = (snd_sonicvibes_in1(sonic, reg)>> shift) & mask;
      spin_unlock_irq(&sonic->reg_lock);
      if (invert)
            ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
      return 0;
}

static int snd_sonicvibes_put_single(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
{
      sonicvibes_t *sonic = snd_kcontrol_chip(kcontrol);
      int reg = kcontrol->private_value & 0xff;
      int shift = (kcontrol->private_value >> 8) & 0xff;
      int mask = (kcontrol->private_value >> 16) & 0xff;
      int invert = (kcontrol->private_value >> 24) & 0xff;
      int change;
      unsigned short val, oval;
      
      val = (ucontrol->value.integer.value[0] & mask);
      if (invert)
            val = mask - val;
      val <<= shift;
      spin_lock_irq(&sonic->reg_lock);
      oval = snd_sonicvibes_in1(sonic, reg);
      val = (oval & ~(mask << shift)) | val;
      change = val != oval;
      snd_sonicvibes_out1(sonic, reg, val);
      spin_unlock_irq(&sonic->reg_lock);
      return change;
}

#define SONICVIBES_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
  .info = snd_sonicvibes_info_double, \
  .get = snd_sonicvibes_get_double, .put = snd_sonicvibes_put_double, \
  .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }

static int snd_sonicvibes_info_double(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
{
      int mask = (kcontrol->private_value >> 24) & 0xff;

      uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
      uinfo->count = 2;
      uinfo->value.integer.min = 0;
      uinfo->value.integer.max = mask;
      return 0;
}

static int snd_sonicvibes_get_double(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
{
      sonicvibes_t *sonic = snd_kcontrol_chip(kcontrol);
      int left_reg = kcontrol->private_value & 0xff;
      int right_reg = (kcontrol->private_value >> 8) & 0xff;
      int shift_left = (kcontrol->private_value >> 16) & 0x07;
      int shift_right = (kcontrol->private_value >> 19) & 0x07;
      int mask = (kcontrol->private_value >> 24) & 0xff;
      int invert = (kcontrol->private_value >> 22) & 1;
      
      spin_lock_irq(&sonic->reg_lock);
      ucontrol->value.integer.value[0] = (snd_sonicvibes_in1(sonic, left_reg) >> shift_left) & mask;
      ucontrol->value.integer.value[1] = (snd_sonicvibes_in1(sonic, right_reg) >> shift_right) & mask;
      spin_unlock_irq(&sonic->reg_lock);
      if (invert) {
            ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
            ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
      }
      return 0;
}

static int snd_sonicvibes_put_double(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
{
      sonicvibes_t *sonic = snd_kcontrol_chip(kcontrol);
      int left_reg = kcontrol->private_value & 0xff;
      int right_reg = (kcontrol->private_value >> 8) & 0xff;
      int shift_left = (kcontrol->private_value >> 16) & 0x07;
      int shift_right = (kcontrol->private_value >> 19) & 0x07;
      int mask = (kcontrol->private_value >> 24) & 0xff;
      int invert = (kcontrol->private_value >> 22) & 1;
      int change;
      unsigned short val1, val2, oval1, oval2;
      
      val1 = ucontrol->value.integer.value[0] & mask;
      val2 = ucontrol->value.integer.value[1] & mask;
      if (invert) {
            val1 = mask - val1;
            val2 = mask - val2;
      }
      val1 <<= shift_left;
      val2 <<= shift_right;
      spin_lock_irq(&sonic->reg_lock);
      oval1 = snd_sonicvibes_in1(sonic, left_reg);
      oval2 = snd_sonicvibes_in1(sonic, right_reg);
      val1 = (oval1 & ~(mask << shift_left)) | val1;
      val2 = (oval2 & ~(mask << shift_right)) | val2;
      change = val1 != oval1 || val2 != oval2;
      snd_sonicvibes_out1(sonic, left_reg, val1);
      snd_sonicvibes_out1(sonic, right_reg, val2);
      spin_unlock_irq(&sonic->reg_lock);
      return change;
}

static snd_kcontrol_new_t snd_sonicvibes_controls[] __devinitdata = {
SONICVIBES_DOUBLE("Capture Volume", 0, SV_IREG_LEFT_ADC, SV_IREG_RIGHT_ADC, 0, 0, 15, 0),
SONICVIBES_DOUBLE("Aux Playback Switch", 0, SV_IREG_LEFT_AUX1, SV_IREG_RIGHT_AUX1, 7, 7, 1, 1),
SONICVIBES_DOUBLE("Aux Playback Volume", 0, SV_IREG_LEFT_AUX1, SV_IREG_RIGHT_AUX1, 0, 0, 31, 1),
SONICVIBES_DOUBLE("CD Playback Switch", 0, SV_IREG_LEFT_CD, SV_IREG_RIGHT_CD, 7, 7, 1, 1),
SONICVIBES_DOUBLE("CD Playback Volume", 0, SV_IREG_LEFT_CD, SV_IREG_RIGHT_CD, 0, 0, 31, 1),
SONICVIBES_DOUBLE("Line Playback Switch", 0, SV_IREG_LEFT_LINE, SV_IREG_RIGHT_LINE, 7, 7, 1, 1),
SONICVIBES_DOUBLE("Line Playback Volume", 0, SV_IREG_LEFT_LINE, SV_IREG_RIGHT_LINE, 0, 0, 31, 1),
SONICVIBES_SINGLE("Mic Playback Switch", 0, SV_IREG_MIC, 7, 1, 1),
SONICVIBES_SINGLE("Mic Playback Volume", 0, SV_IREG_MIC, 0, 15, 1),
SONICVIBES_SINGLE("Mic Boost", 0, SV_IREG_LEFT_ADC, 4, 1, 0),
SONICVIBES_DOUBLE("Synth Playback Switch", 0, SV_IREG_LEFT_SYNTH, SV_IREG_RIGHT_SYNTH, 7, 7, 1, 1),
SONICVIBES_DOUBLE("Synth Playback Volume", 0, SV_IREG_LEFT_SYNTH, SV_IREG_RIGHT_SYNTH, 0, 0, 31, 1),
SONICVIBES_DOUBLE("Aux Playback Switch", 1, SV_IREG_LEFT_AUX2, SV_IREG_RIGHT_AUX2, 7, 7, 1, 1),
SONICVIBES_DOUBLE("Aux Playback Volume", 1, SV_IREG_LEFT_AUX2, SV_IREG_RIGHT_AUX2, 0, 0, 31, 1),
SONICVIBES_DOUBLE("Master Playback Switch", 0, SV_IREG_LEFT_ANALOG, SV_IREG_RIGHT_ANALOG, 7, 7, 1, 1),
SONICVIBES_DOUBLE("Master Playback Volume", 0, SV_IREG_LEFT_ANALOG, SV_IREG_RIGHT_ANALOG, 0, 0, 31, 1),
SONICVIBES_DOUBLE("PCM Playback Switch", 0, SV_IREG_LEFT_PCM, SV_IREG_RIGHT_PCM, 7, 7, 1, 1),
SONICVIBES_DOUBLE("PCM Playback Volume", 0, SV_IREG_LEFT_PCM, SV_IREG_RIGHT_PCM, 0, 0, 63, 1),
SONICVIBES_SINGLE("Loopback Capture Switch", 0, SV_IREG_ADC_OUTPUT_CTRL, 0, 1, 0),
SONICVIBES_SINGLE("Loopback Capture Volume", 0, SV_IREG_ADC_OUTPUT_CTRL, 2, 63, 1),
SONICVIBES_MUX("Capture Source", 0)
};

static void snd_sonicvibes_master_free(snd_kcontrol_t *kcontrol)
{
      sonicvibes_t *sonic = snd_kcontrol_chip(kcontrol);
      sonic->master_mute = NULL;
      sonic->master_volume = NULL;
}

static int __devinit snd_sonicvibes_mixer(sonicvibes_t * sonic)
{
      snd_card_t *card;
      snd_kcontrol_t *kctl;
      unsigned int idx;
      int err;

      snd_assert(sonic != NULL && sonic->card != NULL, return -EINVAL);
      card = sonic->card;
      strcpy(card->mixername, "S3 SonicVibes");

      for (idx = 0; idx < ARRAY_SIZE(snd_sonicvibes_controls); idx++) {
            if ((err = snd_ctl_add(card, kctl = snd_ctl_new1(&snd_sonicvibes_controls[idx], sonic))) < 0)
                  return err;
            switch (idx) {
            case 0:
            case 1: kctl->private_free = snd_sonicvibes_master_free; break;
            }
      }
      return 0;
}

/*

 */

static void snd_sonicvibes_proc_read(snd_info_entry_t *entry, 
                             snd_info_buffer_t * buffer)
{
      sonicvibes_t *sonic = entry->private_data;
      unsigned char tmp;

      tmp = sonic->srs_space & 0x0f;
      snd_iprintf(buffer, "SRS 3D           : %s\n",
                sonic->srs_space & 0x80 ? "off" : "on");
      snd_iprintf(buffer, "SRS Space        : %s\n",
                tmp == 0x00 ? "100%" :
                tmp == 0x01 ? "75%" :
                tmp == 0x02 ? "50%" :
                tmp == 0x03 ? "25%" : "0%");
      tmp = sonic->srs_center & 0x0f;
      snd_iprintf(buffer, "SRS Center       : %s\n",
                tmp == 0x00 ? "100%" :
                tmp == 0x01 ? "75%" :
                tmp == 0x02 ? "50%" :
                tmp == 0x03 ? "25%" : "0%");
      tmp = sonic->wave_source & 0x03;
      snd_iprintf(buffer, "WaveTable Source : %s\n",
                tmp == 0x00 ? "on-board ROM" :
                tmp == 0x01 ? "PCI bus" : "on-board ROM + PCI bus");
      tmp = sonic->mpu_switch;
      snd_iprintf(buffer, "Onboard synth    : %s\n", tmp & 0x01 ? "on" : "off");
      snd_iprintf(buffer, "Ext. Rx to synth : %s\n", tmp & 0x02 ? "on" : "off");
      snd_iprintf(buffer, "MIDI to ext. Tx  : %s\n", tmp & 0x04 ? "on" : "off");
}

static void __devinit snd_sonicvibes_proc_init(sonicvibes_t * sonic)
{
      snd_info_entry_t *entry;

      if (! snd_card_proc_new(sonic->card, "sonicvibes", &entry))
            snd_info_set_text_ops(entry, sonic, 1024, snd_sonicvibes_proc_read);
}

/*

 */

static snd_kcontrol_new_t snd_sonicvibes_game_control __devinitdata =
SONICVIBES_SINGLE("Joystick Speed", 0, SV_IREG_GAME_PORT, 1, 15, 0);

static int snd_sonicvibes_free(sonicvibes_t *sonic)
{
#if defined(CONFIG_GAMEPORT) || (defined(MODULE) && defined(CONFIG_GAMEPORT_MODULE))
      if (sonic->gameport.io)
            gameport_unregister_port(&sonic->gameport);
#endif
      pci_write_config_dword(sonic->pci, 0x40, sonic->dmaa_port);
      pci_write_config_dword(sonic->pci, 0x48, sonic->dmac_port);
      if (sonic->irq >= 0)
            free_irq(sonic->irq, (void *)sonic);
      if (sonic->res_dmaa) {
            release_resource(sonic->res_dmaa);
            kfree_nocheck(sonic->res_dmaa);
      }
      if (sonic->res_dmac) {
            release_resource(sonic->res_dmac);
            kfree_nocheck(sonic->res_dmac);
      }
      pci_release_regions(sonic->pci);
      pci_disable_device(sonic->pci);
      kfree(sonic);
      return 0;
}

static int snd_sonicvibes_dev_free(snd_device_t *device)
{
      sonicvibes_t *sonic = device->device_data;
      return snd_sonicvibes_free(sonic);
}

static int __devinit snd_sonicvibes_create(snd_card_t * card,
                              struct pci_dev *pci,
                              int reverb,
                              int mge,
                              sonicvibes_t ** rsonic)
{
      sonicvibes_t *sonic;
      unsigned int dmaa, dmac;
      int err;
      static snd_device_ops_t ops = {
            .dev_free = snd_sonicvibes_dev_free,
      };

      *rsonic = NULL;
      /* enable PCI device */
      if ((err = pci_enable_device(pci)) < 0)
            return err;
      /* check, if we can restrict PCI DMA transfers to 24 bits */
        if (pci_set_dma_mask(pci, 0x00ffffff) < 0 ||
          pci_set_consistent_dma_mask(pci, 0x00ffffff) < 0) {
                snd_printk("architecture does not support 24bit PCI busmaster DMA\n");
            pci_disable_device(pci);
                return -ENXIO;
        }

      sonic = kcalloc(1, sizeof(*sonic), GFP_KERNEL);
      if (sonic == NULL) {
            pci_disable_device(pci);
            return -ENOMEM;
      }
      spin_lock_init(&sonic->reg_lock);
      sonic->card = card;
      sonic->pci = pci;
      sonic->irq = -1;

      if ((err = pci_request_regions(pci, "S3 SonicVibes")) < 0) {
            kfree(sonic);
            pci_disable_device(pci);
            return err;
      }

      sonic->sb_port = pci_resource_start(pci, 0);
      sonic->enh_port = pci_resource_start(pci, 1);
      sonic->synth_port = pci_resource_start(pci, 2);
      sonic->midi_port = pci_resource_start(pci, 3);
      sonic->game_port = pci_resource_start(pci, 4);

      if (request_irq(pci->irq, snd_sonicvibes_interrupt, SA_INTERRUPT|SA_SHIRQ, "S3 SonicVibes", (void *)sonic)) {
            snd_printk("unable to grab IRQ %d\n", pci->irq);
            snd_sonicvibes_free(sonic);
            return -EBUSY;
      }
      sonic->irq = pci->irq;

      pci_read_config_dword(pci, 0x40, &dmaa);
      pci_read_config_dword(pci, 0x48, &dmac);
      dmaio &= ~0x0f;
      dmaa &= ~0x0f;
      dmac &= ~0x0f;
      if (!dmaa) {
            dmaa = dmaio;
            dmaio += 0x10;
            snd_printk("BIOS did not allocate DDMA channel A i/o, allocated at 0x%x\n", dmaa);
      }
      if (!dmac) {
            dmac = dmaio;
            dmaio += 0x10;
            snd_printk("BIOS did not allocate DDMA channel C i/o, allocated at 0x%x\n", dmac);
      }
      pci_write_config_dword(pci, 0x40, dmaa);
      pci_write_config_dword(pci, 0x48, dmac);

      if ((sonic->res_dmaa = request_region(dmaa, 0x10, "S3 SonicVibes DDMA-A")) == NULL) {
            snd_sonicvibes_free(sonic);
            snd_printk("unable to grab DDMA-A port at 0x%x-0x%x\n", dmaa, dmaa + 0x10 - 1);
            return -EBUSY;
      }
      if ((sonic->res_dmac = request_region(dmac, 0x10, "S3 SonicVibes DDMA-C")) == NULL) {
            snd_sonicvibes_free(sonic);
            snd_printk("unable to grab DDMA-C port at 0x%x-0x%x\n", dmac, dmac + 0x10 - 1);
            return -EBUSY;
      }

      pci_read_config_dword(pci, 0x40, &sonic->dmaa_port);
      pci_read_config_dword(pci, 0x48, &sonic->dmac_port);
      sonic->dmaa_port &= ~0x0f;
      sonic->dmac_port &= ~0x0f;
      pci_write_config_dword(pci, 0x40, sonic->dmaa_port | 9);    /* enable + enhanced */
      pci_write_config_dword(pci, 0x48, sonic->dmac_port | 9);    /* enable */
      /* ok.. initialize S3 SonicVibes chip */
      outb(SV_RESET, SV_REG(sonic, CONTROL));         /* reset chip */
      udelay(100);
      outb(0, SV_REG(sonic, CONTROL));    /* release reset */
      udelay(100);
      outb(SV_ENHANCED | SV_INTA | (reverb ? SV_REVERB : 0), SV_REG(sonic, CONTROL));
      inb(SV_REG(sonic, STATUS));   /* clear IRQs */
#if 1
      snd_sonicvibes_out(sonic, SV_IREG_DRIVE_CTRL, 0);     /* drive current 16mA */
#else
      snd_sonicvibes_out(sonic, SV_IREG_DRIVE_CTRL, 0x40);  /* drive current 8mA */
#endif
      snd_sonicvibes_out(sonic, SV_IREG_PC_ENABLE, sonic->enable = 0);  /* disable playback & capture */
      outb(sonic->irqmask = ~(SV_DMAA_MASK | SV_DMAC_MASK | SV_UD_MASK), SV_REG(sonic, IRQMASK));
      inb(SV_REG(sonic, STATUS));   /* clear IRQs */
      snd_sonicvibes_out(sonic, SV_IREG_ADC_CLOCK, 0);      /* use PLL as clock source */
      snd_sonicvibes_out(sonic, SV_IREG_ANALOG_POWER, 0);   /* power up analog parts */
      snd_sonicvibes_out(sonic, SV_IREG_DIGITAL_POWER, 0);  /* power up digital parts */
      snd_sonicvibes_setpll(sonic, SV_IREG_ADC_PLL, 8000);
      snd_sonicvibes_out(sonic, SV_IREG_SRS_SPACE, sonic->srs_space = 0x80);  /* SRS space off */
      snd_sonicvibes_out(sonic, SV_IREG_SRS_CENTER, sonic->srs_center = 0x00);/* SRS center off */
      snd_sonicvibes_out(sonic, SV_IREG_MPU401, sonic->mpu_switch = 0x05);    /* MPU-401 switch */
      snd_sonicvibes_out(sonic, SV_IREG_WAVE_SOURCE, sonic->wave_source = 0x00);    /* onboard ROM */
      snd_sonicvibes_out(sonic, SV_IREG_PCM_RATE_LOW, (8000 * 65536 / SV_FULLRATE) & 0xff);
      snd_sonicvibes_out(sonic, SV_IREG_PCM_RATE_HIGH, ((8000 * 65536 / SV_FULLRATE) >> 8) & 0xff);
      snd_sonicvibes_out(sonic, SV_IREG_LEFT_ADC, mge ? 0xd0 : 0xc0);
      snd_sonicvibes_out(sonic, SV_IREG_RIGHT_ADC, 0xc0);
      snd_sonicvibes_out(sonic, SV_IREG_LEFT_AUX1, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_RIGHT_AUX1, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_LEFT_CD, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_RIGHT_CD, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_LEFT_LINE, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_RIGHT_LINE, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_MIC, 0x8f);
      snd_sonicvibes_out(sonic, SV_IREG_LEFT_SYNTH, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_RIGHT_SYNTH, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_LEFT_AUX2, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_RIGHT_AUX2, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_LEFT_ANALOG, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_RIGHT_ANALOG, 0x9f);
      snd_sonicvibes_out(sonic, SV_IREG_LEFT_PCM, 0xbf);
      snd_sonicvibes_out(sonic, SV_IREG_RIGHT_PCM, 0xbf);
      snd_sonicvibes_out(sonic, SV_IREG_ADC_OUTPUT_CTRL, 0xfc);
#if 0
      snd_sonicvibes_debug(sonic);
#endif
      sonic->revision = snd_sonicvibes_in(sonic, SV_IREG_REVISION);
      snd_ctl_add(card, snd_ctl_new1(&snd_sonicvibes_game_control, sonic));

      if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, sonic, &ops)) < 0) {
            snd_sonicvibes_free(sonic);
            return err;
      }

      snd_sonicvibes_proc_init(sonic);

      snd_card_set_dev(card, &pci->dev);

      *rsonic = sonic;
      return 0;
}

/*
 *  MIDI section
 */

static snd_kcontrol_new_t snd_sonicvibes_midi_controls[] __devinitdata = {
SONICVIBES_SINGLE("SonicVibes Wave Source RAM", 0, SV_IREG_WAVE_SOURCE, 0, 1, 0),
SONICVIBES_SINGLE("SonicVibes Wave Source RAM+ROM", 0, SV_IREG_WAVE_SOURCE, 1, 1, 0),
SONICVIBES_SINGLE("SonicVibes Onboard Synth", 0, SV_IREG_MPU401, 0, 1, 0),
SONICVIBES_SINGLE("SonicVibes External Rx to Synth", 0, SV_IREG_MPU401, 1, 1, 0),
SONICVIBES_SINGLE("SonicVibes External Tx", 0, SV_IREG_MPU401, 2, 1, 0)
};

static int snd_sonicvibes_midi_input_open(mpu401_t * mpu)
{
      sonicvibes_t *sonic = mpu->private_data;
      outb(sonic->irqmask &= ~SV_MIDI_MASK, SV_REG(sonic, IRQMASK));
      return 0;
}

static void snd_sonicvibes_midi_input_close(mpu401_t * mpu)
{
      sonicvibes_t *sonic = mpu->private_data;
      outb(sonic->irqmask |= SV_MIDI_MASK, SV_REG(sonic, IRQMASK));
}

static int __devinit snd_sonicvibes_midi(sonicvibes_t * sonic, snd_rawmidi_t * rmidi)
{
      mpu401_t * mpu = rmidi->private_data;
      snd_card_t *card = sonic->card;
      snd_rawmidi_str_t *dir;
      unsigned int idx;
      int err;

      mpu->private_data = sonic;
      mpu->open_input = snd_sonicvibes_midi_input_open;
      mpu->close_input = snd_sonicvibes_midi_input_close;
      dir = &rmidi->streams[SNDRV_RAWMIDI_STREAM_OUTPUT];
      for (idx = 0; idx < ARRAY_SIZE(snd_sonicvibes_midi_controls); idx++)
            if ((err = snd_ctl_add(card, snd_ctl_new1(&snd_sonicvibes_midi_controls[idx], sonic))) < 0)
                  return err;
      return 0;
}

static int __devinit snd_sonic_probe(struct pci_dev *pci,
                             const struct pci_device_id *pci_id)
{
      static int dev;
      snd_card_t *card;
      sonicvibes_t *sonic;
      snd_rawmidi_t *midi_uart;
      opl3_t *opl3;
      int idx, err;

      if (dev >= SNDRV_CARDS)
            return -ENODEV;
      if (!enable[dev]) {
            dev++;
            return -ENOENT;
      }
 
      card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
      if (card == NULL)
            return -ENOMEM;
      for (idx = 0; idx < 5; idx++) {
            if (pci_resource_start(pci, idx) == 0 ||
                !(pci_resource_flags(pci, idx) & IORESOURCE_IO)) {
                  snd_card_free(card);
                  return -ENODEV;
            }
      }
      if ((err = snd_sonicvibes_create(card, pci,
                               reverb[dev] ? 1 : 0,
                               mge[dev] ? 1 : 0,
                               &sonic)) < 0) {
            snd_card_free(card);
            return err;
      }

      strcpy(card->driver, "SonicVibes");
      strcpy(card->shortname, "S3 SonicVibes");
      sprintf(card->longname, "%s rev %i at 0x%lx, irq %i",
            card->shortname,
            sonic->revision,
            pci_resource_start(pci, 1),
            sonic->irq);

      if ((err = snd_sonicvibes_pcm(sonic, 0, NULL)) < 0) {
            snd_card_free(card);
            return err;
      }
      if ((err = snd_sonicvibes_mixer(sonic)) < 0) {
            snd_card_free(card);
            return err;
      }
      if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_SONICVIBES,
                               sonic->midi_port, 1,
                               sonic->irq, 0,
                               &midi_uart)) < 0) {
            snd_card_free(card);
            return err;
      }
      snd_sonicvibes_midi(sonic, midi_uart);
      if ((err = snd_opl3_create(card, sonic->synth_port,
                           sonic->synth_port + 2,
                           OPL3_HW_OPL3_SV, 1, &opl3)) < 0) {
            snd_card_free(card);
            return err;
      }
      if ((err = snd_opl3_hwdep_new(opl3, 0, 1, NULL)) < 0) {
            snd_card_free(card);
            return err;
      }
#if defined(CONFIG_GAMEPORT) || (defined(MODULE) && defined(CONFIG_GAMEPORT_MODULE))
      sonic->gameport.io = sonic->game_port;
      gameport_register_port(&sonic->gameport);
#endif

      if ((err = snd_card_register(card)) < 0) {
            snd_card_free(card);
            return err;
      }
      
      pci_set_drvdata(pci, card);
      dev++;
      return 0;
}

static void __devexit snd_sonic_remove(struct pci_dev *pci)
{
      snd_card_free(pci_get_drvdata(pci));
      pci_set_drvdata(pci, NULL);
}

static struct pci_driver driver = {
      .name = "S3 SonicVibes",
      .id_table = snd_sonic_ids,
      .probe = snd_sonic_probe,
      .remove = __devexit_p(snd_sonic_remove),
};

static int __init alsa_card_sonicvibes_init(void)
{
      return pci_module_init(&driver);
}

static void __exit alsa_card_sonicvibes_exit(void)
{
      pci_unregister_driver(&driver);
}

module_init(alsa_card_sonicvibes_init)
module_exit(alsa_card_sonicvibes_exit)

Generated by  Doxygen 1.6.0   Back to index