sound/pci/trident/trident.h - linux - Git at Google

 /* SPDX-License-Identifier: GPL-2.0-or-later */
 #ifndef __SOUND_TRIDENT_H
 #define __SOUND_TRIDENT_H

 /*
  *  audio@tridentmicro.com
  *  Fri Feb 19 15:55:28 MST 1999
  *  Definitions for Trident 4DWave DX/NX chips
  */

 #include <sound/pcm.h>
 #include <sound/mpu401.h>
 #include <sound/ac97_codec.h>
 #include <sound/util_mem.h>

 #define TRIDENT_DEVICE_ID_DX		((PCI_VENDOR_ID_TRIDENT<<16)|PCI_DEVICE_ID_TRIDENT_4DWAVE_DX)
 #define TRIDENT_DEVICE_ID_NX		((PCI_VENDOR_ID_TRIDENT<<16)|PCI_DEVICE_ID_TRIDENT_4DWAVE_NX)
 #define TRIDENT_DEVICE_ID_SI7018	((PCI_VENDOR_ID_SI<<16)|PCI_DEVICE_ID_SI_7018)

 #define SNDRV_TRIDENT_VOICE_TYPE_PCM		0
 #define SNDRV_TRIDENT_VOICE_TYPE_SYNTH		1
 #define SNDRV_TRIDENT_VOICE_TYPE_MIDI		2

 #define SNDRV_TRIDENT_VFLG_RUNNING		(1<<0)

 /* TLB code constants */
 #define SNDRV_TRIDENT_PAGE_SIZE			4096
 #define SNDRV_TRIDENT_PAGE_SHIFT			12
 #define SNDRV_TRIDENT_PAGE_MASK			((1<<SNDRV_TRIDENT_PAGE_SHIFT)-1)
 #define SNDRV_TRIDENT_MAX_PAGES			4096

 /*
  * Direct registers
  */

 #define TRID_REG(trident, x) ((trident)->port + (x))

 #define ID_4DWAVE_DX        0x2000
 #define ID_4DWAVE_NX        0x2001

 /* Bank definitions */

 #define T4D_BANK_A	0
 #define T4D_BANK_B	1
 #define T4D_NUM_BANKS	2

 /* Register definitions */

 /* Global registers */

 enum global_control_bits {
 	CHANNEL_IDX	= 0x0000003f,
 	OVERRUN_IE	= 0x00000400,	/* interrupt enable: capture overrun */
 	UNDERRUN_IE	= 0x00000800,	/* interrupt enable: playback underrun */
 	ENDLP_IE	= 0x00001000,	/* interrupt enable: end of buffer */
 	MIDLP_IE	= 0x00002000,	/* interrupt enable: middle buffer */
 	ETOG_IE		= 0x00004000,	/* interrupt enable: envelope toggling */
 	EDROP_IE	= 0x00008000,	/* interrupt enable: envelope drop */
 	BANK_B_EN	= 0x00010000,	/* SiS: enable bank B (64 channels) */
 	PCMIN_B_MIX	= 0x00020000,	/* SiS: PCM IN B mixing enable */
 	I2S_OUT_ASSIGN	= 0x00040000,	/* SiS: I2S Out contains surround PCM */
 	SPDIF_OUT_ASSIGN= 0x00080000,	/* SiS: 0=S/PDIF L/R | 1=PCM Out FIFO */
 	MAIN_OUT_ASSIGN = 0x00100000,	/* SiS: 0=PCM Out FIFO | 1=MMC Out buffer */
 };

 enum miscint_bits {
 	PB_UNDERRUN_IRQ = 0x00000001, REC_OVERRUN_IRQ = 0x00000002,
 	SB_IRQ		= 0x00000004, MPU401_IRQ      = 0x00000008,
 	OPL3_IRQ        = 0x00000010, ADDRESS_IRQ     = 0x00000020,
 	ENVELOPE_IRQ    = 0x00000040, PB_UNDERRUN     = 0x00000100,
 	REC_OVERRUN	= 0x00000200, MIXER_UNDERFLOW = 0x00000400,
 	MIXER_OVERFLOW  = 0x00000800, NX_SB_IRQ_DISABLE = 0x00001000,
         ST_TARGET_REACHED = 0x00008000,
 	PB_24K_MODE     = 0x00010000, ST_IRQ_EN       = 0x00800000,
 	ACGPIO_IRQ	= 0x01000000
 };

 /* T2 legacy dma control registers. */
 #define LEGACY_DMAR0                0x00  // ADR0
 #define LEGACY_DMAR4                0x04  // CNT0
 #define LEGACY_DMAR6		    0x06  // CNT0 - High bits
 #define LEGACY_DMAR11               0x0b  // MOD
 #define LEGACY_DMAR15               0x0f  // MMR

 #define T4D_START_A		     0x80
 #define T4D_STOP_A		     0x84
 #define T4D_DLY_A		     0x88
 #define T4D_SIGN_CSO_A		     0x8c
 #define T4D_CSPF_A		     0x90
 #define T4D_CSPF_B		     0xbc
 #define T4D_CEBC_A		     0x94
 #define T4D_AINT_A		     0x98
 #define T4D_AINTEN_A		     0x9c
 #define T4D_LFO_GC_CIR               0xa0
 #define T4D_MUSICVOL_WAVEVOL         0xa8
 #define T4D_SBDELTA_DELTA_R          0xac
 #define T4D_MISCINT                  0xb0
 #define T4D_START_B                  0xb4
 #define T4D_STOP_B                   0xb8
 #define T4D_SBBL_SBCL                0xc0
 #define T4D_SBCTRL_SBE2R_SBDD        0xc4
 #define T4D_STIMER		     0xc8
 #define T4D_AINT_B                   0xd8
 #define T4D_AINTEN_B                 0xdc
 #define T4D_RCI                      0x70

 /* MPU-401 UART */
 #define T4D_MPU401_BASE             0x20
 #define T4D_MPUR0                   0x20
 #define T4D_MPUR1                   0x21
 #define T4D_MPUR2                   0x22
 #define T4D_MPUR3                   0x23

 /* S/PDIF Registers */
 #define NX_SPCTRL_SPCSO             0x24
 #define NX_SPLBA                    0x28
 #define NX_SPESO                    0x2c
 #define NX_SPCSTATUS                0x64

 /* Joystick */
 #define GAMEPORT_GCR                0x30
 #define GAMEPORT_MODE_ADC           0x80
 #define GAMEPORT_LEGACY             0x31
 #define GAMEPORT_AXES               0x34

 /* NX Specific Registers */
 #define NX_TLBC                     0x6c

 /* Channel Registers */

 #define CH_START		    0xe0

 #define CH_DX_CSO_ALPHA_FMS         0xe0
 #define CH_DX_ESO_DELTA             0xe8
 #define CH_DX_FMC_RVOL_CVOL         0xec

 #define CH_NX_DELTA_CSO             0xe0
 #define CH_NX_DELTA_ESO             0xe8
 #define CH_NX_ALPHA_FMS_FMC_RVOL_CVOL 0xec

 #define CH_LBA                      0xe4
 #define CH_GVSEL_PAN_VOL_CTRL_EC    0xf0
 #define CH_EBUF1                    0xf4
 #define CH_EBUF2                    0xf8

 /* AC-97 Registers */

 #define DX_ACR0_AC97_W              0x40
 #define DX_ACR1_AC97_R              0x44
 #define DX_ACR2_AC97_COM_STAT       0x48

 #define NX_ACR0_AC97_COM_STAT       0x40
 #define NX_ACR1_AC97_W              0x44
 #define NX_ACR2_AC97_R_PRIMARY      0x48
 #define NX_ACR3_AC97_R_SECONDARY    0x4c

 #define SI_AC97_WRITE		    0x40
 #define SI_AC97_READ		    0x44
 #define SI_SERIAL_INTF_CTRL	    0x48
 #define SI_AC97_GPIO		    0x4c
 #define SI_ASR0			    0x50
 #define SI_SPDIF_CS		    0x70
 #define SI_GPIO			    0x7c

 enum trident_nx_ac97_bits {
 	/* ACR1-3 */
 	NX_AC97_BUSY_WRITE 	= 0x0800,
 	NX_AC97_BUSY_READ	= 0x0800,
 	NX_AC97_BUSY_DATA 	= 0x0400,
 	NX_AC97_WRITE_SECONDARY = 0x0100,
 	/* ACR0 */
 	NX_AC97_SECONDARY_READY = 0x0040,
 	NX_AC97_SECONDARY_RECORD = 0x0020,
 	NX_AC97_SURROUND_OUTPUT = 0x0010,
 	NX_AC97_PRIMARY_READY	= 0x0008,
 	NX_AC97_PRIMARY_RECORD	= 0x0004,
 	NX_AC97_PCM_OUTPUT	= 0x0002,
 	NX_AC97_WARM_RESET	= 0x0001
 };

 enum trident_dx_ac97_bits {
 	DX_AC97_BUSY_WRITE	= 0x8000,
 	DX_AC97_BUSY_READ	= 0x8000,
 	DX_AC97_READY		= 0x0010,
 	DX_AC97_RECORD		= 0x0008,
 	DX_AC97_PLAYBACK	= 0x0002
 };

 enum sis7018_ac97_bits {
 	SI_AC97_BUSY_WRITE =	0x00008000,
 	SI_AC97_AUDIO_BUSY =	0x00004000,
 	SI_AC97_MODEM_BUSY =	0x00002000,
 	SI_AC97_BUSY_READ =	0x00008000,
 	SI_AC97_SECONDARY =	0x00000080,
 };

 enum serial_intf_ctrl_bits {
 	WARM_RESET	= 0x00000001,
 	COLD_RESET	= 0x00000002,
 	I2S_CLOCK	= 0x00000004,
 	PCM_SEC_AC97	= 0x00000008,
 	AC97_DBL_RATE	= 0x00000010,
 	SPDIF_EN	= 0x00000020,
 	I2S_OUTPUT_EN	= 0x00000040,
 	I2S_INPUT_EN	= 0x00000080,
 	PCMIN		= 0x00000100,
 	LINE1IN		= 0x00000200,
 	MICIN		= 0x00000400,
 	LINE2IN		= 0x00000800,
 	HEAD_SET_IN	= 0x00001000,
 	GPIOIN		= 0x00002000,
 	/* 7018 spec says id = 01 but the demo board routed to 10
 	   SECONDARY_ID= 0x00004000, */
 	SECONDARY_ID	= 0x00004000,
 	PCMOUT		= 0x00010000,
 	SURROUT		= 0x00020000,
 	CENTEROUT	= 0x00040000,
 	LFEOUT		= 0x00080000,
 	LINE1OUT	= 0x00100000,
 	LINE2OUT	= 0x00200000,
 	GPIOOUT		= 0x00400000,
 	SI_AC97_PRIMARY_READY = 0x01000000,
 	SI_AC97_SECONDARY_READY = 0x02000000,
 	SI_AC97_POWERDOWN = 0x04000000,
 };

 /* PCM defaults */

 #define T4D_DEFAULT_PCM_VOL	10	/* 0 - 255 */
 #define T4D_DEFAULT_PCM_PAN	0	/* 0 - 127 */
 #define T4D_DEFAULT_PCM_RVOL	127	/* 0 - 127 */
 #define T4D_DEFAULT_PCM_CVOL	127	/* 0 - 127 */

 struct snd_trident;
 struct snd_trident_voice;
 struct snd_trident_pcm_mixer;

 struct snd_trident_port {
 	struct snd_midi_channel_set * chset;
 	struct snd_trident * trident;
 	int mode;		/* operation mode */
 	int client;		/* sequencer client number */
 	int port;		/* sequencer port number */
 	unsigned int midi_has_voices: 1;
 };

 struct snd_trident_memblk_arg {
 	short first_page, last_page;
 };

 struct snd_trident_tlb {
 	__le32 *entries;		/* 16k-aligned TLB table */
 	dma_addr_t entries_dmaaddr;	/* 16k-aligned PCI address to TLB table */
 	struct snd_dma_buffer *buffer;
 	struct snd_util_memhdr * memhdr;	/* page allocation list */
 	struct snd_dma_buffer *silent_page;
 };

 struct snd_trident_voice {
 	unsigned int number;
 	unsigned int use: 1,
 	    pcm: 1,
 	    synth:1,
 	    midi: 1;
 	unsigned int flags;
 	unsigned char client;
 	unsigned char port;
 	unsigned char index;

 	struct snd_trident_sample_ops *sample_ops;

 	/* channel parameters */
 	unsigned int CSO;		/* 24 bits (16 on DX) */
 	unsigned int ESO;		/* 24 bits (16 on DX) */
 	unsigned int LBA;		/* 30 bits */
 	unsigned short EC;		/* 12 bits */
 	unsigned short Alpha;		/* 12 bits */
 	unsigned short Delta;		/* 16 bits */
 	unsigned short Attribute;	/* 16 bits - SiS 7018 */
 	unsigned short Vol;		/* 12 bits (6.6) */
 	unsigned char Pan;		/* 7 bits (1.4.2) */
 	unsigned char GVSel;		/* 1 bit */
 	unsigned char RVol;		/* 7 bits (5.2) */
 	unsigned char CVol;		/* 7 bits (5.2) */
 	unsigned char FMC;		/* 2 bits */
 	unsigned char CTRL;		/* 4 bits */
 	unsigned char FMS;		/* 4 bits */
 	unsigned char LFO;		/* 8 bits */

 	unsigned int negCSO;	/* nonzero - use negative CSO */

 	struct snd_util_memblk *memblk;	/* memory block if TLB enabled */

 	/* PCM data */

 	struct snd_trident *trident;
 	struct snd_pcm_substream *substream;
 	struct snd_trident_voice *extra;	/* extra PCM voice (acts as interrupt generator) */
 	unsigned int running: 1,
             capture: 1,
             spdif: 1,
             foldback: 1,
             isync: 1,
             isync2: 1,
             isync3: 1;
 	int foldback_chan;		/* foldback subdevice number */
 	unsigned int stimer;		/* global sample timer (to detect spurious interrupts) */
 	unsigned int spurious_threshold; /* spurious threshold */
 	unsigned int isync_mark;
 	unsigned int isync_max;
 	unsigned int isync_ESO;

 	/* --- */

 	void *private_data;
 	void (*private_free)(struct snd_trident_voice *voice);
 };

 struct snd_4dwave {
 	int seq_client;

 	struct snd_trident_port seq_ports[4];
 	struct snd_trident_voice voices[64];

 	int ChanSynthCount;		/* number of allocated synth channels */
 	int max_size;			/* maximum synth memory size in bytes */
 	int current_size;		/* current allocated synth mem in bytes */
 };

 struct snd_trident_pcm_mixer {
 	struct snd_trident_voice *voice;	/* active voice */
 	unsigned short vol;		/* front volume */
 	unsigned char pan;		/* pan control */
 	unsigned char rvol;		/* rear volume */
 	unsigned char cvol;		/* center volume */
 	unsigned char pad;
 };

 struct snd_trident {
 	int irq;

 	unsigned int device;	/* device ID */

         unsigned char  bDMAStart;

 	unsigned long port;
 	unsigned long midi_port;

 	unsigned int spurious_irq_count;
 	unsigned int spurious_irq_max_delta;

         struct snd_trident_tlb tlb;	/* TLB entries for NX cards */

 	unsigned char spdif_ctrl;
 	unsigned char spdif_pcm_ctrl;
 	unsigned int spdif_bits;
 	unsigned int spdif_pcm_bits;
 	struct snd_kcontrol *spdif_pcm_ctl;	/* S/PDIF settings */
 	unsigned int ac97_ctrl;

         unsigned int ChanMap[2];	/* allocation map for hardware channels */

         int ChanPCM;			/* max number of PCM channels */
 	int ChanPCMcnt;			/* actual number of PCM channels */

 	unsigned int ac97_detect: 1;	/* 1 = AC97 in detection phase */
 	unsigned int in_suspend: 1;	/* 1 during suspend/resume */

 	struct snd_4dwave synth;	/* synth specific variables */

 	spinlock_t event_lock;
 	spinlock_t voice_alloc;

 	struct snd_dma_device dma_dev;

 	struct pci_dev *pci;
 	struct snd_card *card;
 	struct snd_pcm *pcm;		/* ADC/DAC PCM */
 	struct snd_pcm *foldback;	/* Foldback PCM */
 	struct snd_pcm *spdif;	/* SPDIF PCM */
 	struct snd_rawmidi *rmidi;

 	struct snd_ac97_bus *ac97_bus;
 	struct snd_ac97 *ac97;
 	struct snd_ac97 *ac97_sec;

 	unsigned int musicvol_wavevol;
 	struct snd_trident_pcm_mixer pcm_mixer[32];
 	struct snd_kcontrol *ctl_vol;	/* front volume */
 	struct snd_kcontrol *ctl_pan;	/* pan */
 	struct snd_kcontrol *ctl_rvol;	/* rear volume */
 	struct snd_kcontrol *ctl_cvol;	/* center volume */

 	spinlock_t reg_lock;

 	struct gameport *gameport;
 };

 int snd_trident_create(struct snd_card *card,
 		       struct pci_dev *pci,
 		       int pcm_streams,
 		       int pcm_spdif_device,
 		       int max_wavetable_size);
 int snd_trident_create_gameport(struct snd_trident *trident);

 int snd_trident_pcm(struct snd_trident *trident, int device);
 int snd_trident_foldback_pcm(struct snd_trident *trident, int device);
 int snd_trident_spdif_pcm(struct snd_trident *trident, int device);
 struct snd_trident_voice *snd_trident_alloc_voice(struct snd_trident * trident, int type,
 					     int client, int port);
 void snd_trident_free_voice(struct snd_trident * trident, struct snd_trident_voice *voice);
 void snd_trident_start_voice(struct snd_trident * trident, unsigned int voice);
 void snd_trident_stop_voice(struct snd_trident * trident, unsigned int voice);
 void snd_trident_write_voice_regs(struct snd_trident * trident, struct snd_trident_voice *voice);
 extern const struct dev_pm_ops snd_trident_pm;

 /* TLB memory allocation */
 struct snd_util_memblk *snd_trident_alloc_pages(struct snd_trident *trident,
 						struct snd_pcm_substream *substream);
 int snd_trident_free_pages(struct snd_trident *trident, struct snd_util_memblk *blk);

 #endif /* __SOUND_TRIDENT_H */
	/* SPDX-License-Identifier: GPL-2.0-or-later */
	#ifndef __SOUND_TRIDENT_H
	#define __SOUND_TRIDENT_H

	/*
	* audio@tridentmicro.com
	* Fri Feb 19 15:55:28 MST 1999
	* Definitions for Trident 4DWave DX/NX chips
	*/

	#include <sound/pcm.h>
	#include <sound/mpu401.h>
	#include <sound/ac97_codec.h>
	#include <sound/util_mem.h>

	#define TRIDENT_DEVICE_ID_DX ((PCI_VENDOR_ID_TRIDENT<<16)\|PCI_DEVICE_ID_TRIDENT_4DWAVE_DX)
	#define TRIDENT_DEVICE_ID_NX ((PCI_VENDOR_ID_TRIDENT<<16)\|PCI_DEVICE_ID_TRIDENT_4DWAVE_NX)
	#define TRIDENT_DEVICE_ID_SI7018 ((PCI_VENDOR_ID_SI<<16)\|PCI_DEVICE_ID_SI_7018)

	#define SNDRV_TRIDENT_VOICE_TYPE_PCM 0
	#define SNDRV_TRIDENT_VOICE_TYPE_SYNTH 1
	#define SNDRV_TRIDENT_VOICE_TYPE_MIDI 2

	#define SNDRV_TRIDENT_VFLG_RUNNING (1<<0)

	/* TLB code constants */
	#define SNDRV_TRIDENT_PAGE_SIZE 4096
	#define SNDRV_TRIDENT_PAGE_SHIFT 12
	#define SNDRV_TRIDENT_PAGE_MASK ((1<<SNDRV_TRIDENT_PAGE_SHIFT)-1)
	#define SNDRV_TRIDENT_MAX_PAGES 4096

	/*
	* Direct registers
	*/

	#define TRID_REG(trident, x) ((trident)->port + (x))

	#define ID_4DWAVE_DX 0x2000
	#define ID_4DWAVE_NX 0x2001

	/* Bank definitions */

	#define T4D_BANK_A 0
	#define T4D_BANK_B 1
	#define T4D_NUM_BANKS 2

	/* Register definitions */

	/* Global registers */

	enum global_control_bits {
	CHANNEL_IDX = 0x0000003f,
	OVERRUN_IE = 0x00000400, /* interrupt enable: capture overrun */
	UNDERRUN_IE = 0x00000800, /* interrupt enable: playback underrun */
	ENDLP_IE = 0x00001000, /* interrupt enable: end of buffer */
	MIDLP_IE = 0x00002000, /* interrupt enable: middle buffer */
	ETOG_IE = 0x00004000, /* interrupt enable: envelope toggling */
	EDROP_IE = 0x00008000, /* interrupt enable: envelope drop */
	BANK_B_EN = 0x00010000, /* SiS: enable bank B (64 channels) */
	PCMIN_B_MIX = 0x00020000, /* SiS: PCM IN B mixing enable */
	I2S_OUT_ASSIGN = 0x00040000, /* SiS: I2S Out contains surround PCM */
	SPDIF_OUT_ASSIGN= 0x00080000, /* SiS: 0=S/PDIF L/R \| 1=PCM Out FIFO */
	MAIN_OUT_ASSIGN = 0x00100000, /* SiS: 0=PCM Out FIFO \| 1=MMC Out buffer */
	};

	enum miscint_bits {
	PB_UNDERRUN_IRQ = 0x00000001, REC_OVERRUN_IRQ = 0x00000002,
	SB_IRQ = 0x00000004, MPU401_IRQ = 0x00000008,
	OPL3_IRQ = 0x00000010, ADDRESS_IRQ = 0x00000020,
	ENVELOPE_IRQ = 0x00000040, PB_UNDERRUN = 0x00000100,
	REC_OVERRUN = 0x00000200, MIXER_UNDERFLOW = 0x00000400,
	MIXER_OVERFLOW = 0x00000800, NX_SB_IRQ_DISABLE = 0x00001000,
	ST_TARGET_REACHED = 0x00008000,
	PB_24K_MODE = 0x00010000, ST_IRQ_EN = 0x00800000,
	ACGPIO_IRQ = 0x01000000
	};

	/* T2 legacy dma control registers. */
	#define LEGACY_DMAR0 0x00 // ADR0
	#define LEGACY_DMAR4 0x04 // CNT0
	#define LEGACY_DMAR6 0x06 // CNT0 - High bits
	#define LEGACY_DMAR11 0x0b // MOD
	#define LEGACY_DMAR15 0x0f // MMR

	#define T4D_START_A 0x80
	#define T4D_STOP_A 0x84
	#define T4D_DLY_A 0x88
	#define T4D_SIGN_CSO_A 0x8c
	#define T4D_CSPF_A 0x90
	#define T4D_CSPF_B 0xbc
	#define T4D_CEBC_A 0x94
	#define T4D_AINT_A 0x98
	#define T4D_AINTEN_A 0x9c
	#define T4D_LFO_GC_CIR 0xa0
	#define T4D_MUSICVOL_WAVEVOL 0xa8
	#define T4D_SBDELTA_DELTA_R 0xac
	#define T4D_MISCINT 0xb0
	#define T4D_START_B 0xb4
	#define T4D_STOP_B 0xb8
	#define T4D_SBBL_SBCL 0xc0
	#define T4D_SBCTRL_SBE2R_SBDD 0xc4
	#define T4D_STIMER 0xc8
	#define T4D_AINT_B 0xd8
	#define T4D_AINTEN_B 0xdc
	#define T4D_RCI 0x70

	/* MPU-401 UART */
	#define T4D_MPU401_BASE 0x20
	#define T4D_MPUR0 0x20
	#define T4D_MPUR1 0x21
	#define T4D_MPUR2 0x22
	#define T4D_MPUR3 0x23

	/* S/PDIF Registers */
	#define NX_SPCTRL_SPCSO 0x24
	#define NX_SPLBA 0x28
	#define NX_SPESO 0x2c
	#define NX_SPCSTATUS 0x64

	/* Joystick */
	#define GAMEPORT_GCR 0x30
	#define GAMEPORT_MODE_ADC 0x80
	#define GAMEPORT_LEGACY 0x31
	#define GAMEPORT_AXES 0x34

	/* NX Specific Registers */
	#define NX_TLBC 0x6c

	/* Channel Registers */

	#define CH_START 0xe0

	#define CH_DX_CSO_ALPHA_FMS 0xe0
	#define CH_DX_ESO_DELTA 0xe8
	#define CH_DX_FMC_RVOL_CVOL 0xec

	#define CH_NX_DELTA_CSO 0xe0
	#define CH_NX_DELTA_ESO 0xe8
	#define CH_NX_ALPHA_FMS_FMC_RVOL_CVOL 0xec

	#define CH_LBA 0xe4
	#define CH_GVSEL_PAN_VOL_CTRL_EC 0xf0
	#define CH_EBUF1 0xf4
	#define CH_EBUF2 0xf8

	/* AC-97 Registers */

	#define DX_ACR0_AC97_W 0x40
	#define DX_ACR1_AC97_R 0x44
	#define DX_ACR2_AC97_COM_STAT 0x48

	#define NX_ACR0_AC97_COM_STAT 0x40
	#define NX_ACR1_AC97_W 0x44
	#define NX_ACR2_AC97_R_PRIMARY 0x48
	#define NX_ACR3_AC97_R_SECONDARY 0x4c

	#define SI_AC97_WRITE 0x40
	#define SI_AC97_READ 0x44
	#define SI_SERIAL_INTF_CTRL 0x48
	#define SI_AC97_GPIO 0x4c
	#define SI_ASR0 0x50
	#define SI_SPDIF_CS 0x70
	#define SI_GPIO 0x7c

	enum trident_nx_ac97_bits {
	/* ACR1-3 */
	NX_AC97_BUSY_WRITE = 0x0800,
	NX_AC97_BUSY_READ = 0x0800,
	NX_AC97_BUSY_DATA = 0x0400,
	NX_AC97_WRITE_SECONDARY = 0x0100,
	/* ACR0 */
	NX_AC97_SECONDARY_READY = 0x0040,
	NX_AC97_SECONDARY_RECORD = 0x0020,
	NX_AC97_SURROUND_OUTPUT = 0x0010,
	NX_AC97_PRIMARY_READY = 0x0008,
	NX_AC97_PRIMARY_RECORD = 0x0004,
	NX_AC97_PCM_OUTPUT = 0x0002,
	NX_AC97_WARM_RESET = 0x0001
	};

	enum trident_dx_ac97_bits {
	DX_AC97_BUSY_WRITE = 0x8000,
	DX_AC97_BUSY_READ = 0x8000,
	DX_AC97_READY = 0x0010,
	DX_AC97_RECORD = 0x0008,
	DX_AC97_PLAYBACK = 0x0002
	};

	enum sis7018_ac97_bits {
	SI_AC97_BUSY_WRITE = 0x00008000,
	SI_AC97_AUDIO_BUSY = 0x00004000,
	SI_AC97_MODEM_BUSY = 0x00002000,
	SI_AC97_BUSY_READ = 0x00008000,
	SI_AC97_SECONDARY = 0x00000080,
	};

	enum serial_intf_ctrl_bits {
	WARM_RESET = 0x00000001,
	COLD_RESET = 0x00000002,
	I2S_CLOCK = 0x00000004,
	PCM_SEC_AC97 = 0x00000008,
	AC97_DBL_RATE = 0x00000010,
	SPDIF_EN = 0x00000020,
	I2S_OUTPUT_EN = 0x00000040,
	I2S_INPUT_EN = 0x00000080,
	PCMIN = 0x00000100,
	LINE1IN = 0x00000200,
	MICIN = 0x00000400,
	LINE2IN = 0x00000800,
	HEAD_SET_IN = 0x00001000,
	GPIOIN = 0x00002000,
	/* 7018 spec says id = 01 but the demo board routed to 10
	SECONDARY_ID= 0x00004000, */
	SECONDARY_ID = 0x00004000,
	PCMOUT = 0x00010000,
	SURROUT = 0x00020000,
	CENTEROUT = 0x00040000,
	LFEOUT = 0x00080000,
	LINE1OUT = 0x00100000,
	LINE2OUT = 0x00200000,
	GPIOOUT = 0x00400000,
	SI_AC97_PRIMARY_READY = 0x01000000,
	SI_AC97_SECONDARY_READY = 0x02000000,
	SI_AC97_POWERDOWN = 0x04000000,
	};

	/* PCM defaults */

	#define T4D_DEFAULT_PCM_VOL 10 /* 0 - 255 */
	#define T4D_DEFAULT_PCM_PAN 0 /* 0 - 127 */
	#define T4D_DEFAULT_PCM_RVOL 127 /* 0 - 127 */
	#define T4D_DEFAULT_PCM_CVOL 127 /* 0 - 127 */

	struct snd_trident;
	struct snd_trident_voice;
	struct snd_trident_pcm_mixer;

	struct snd_trident_port {
	struct snd_midi_channel_set * chset;
	struct snd_trident * trident;
	int mode; /* operation mode */
	int client; /* sequencer client number */
	int port; /* sequencer port number */
	unsigned int midi_has_voices: 1;
	};

	struct snd_trident_memblk_arg {
	short first_page, last_page;
	};

	struct snd_trident_tlb {
	__le32 entries; / 16k-aligned TLB table */
	dma_addr_t entries_dmaaddr; /* 16k-aligned PCI address to TLB table */
	struct snd_dma_buffer *buffer;
	struct snd_util_memhdr * memhdr; /* page allocation list */
	struct snd_dma_buffer *silent_page;
	};

	struct snd_trident_voice {
	unsigned int number;
	unsigned int use: 1,
	pcm: 1,
	synth:1,
	midi: 1;
	unsigned int flags;
	unsigned char client;
	unsigned char port;
	unsigned char index;

	struct snd_trident_sample_ops *sample_ops;

	/* channel parameters */
	unsigned int CSO; /* 24 bits (16 on DX) */
	unsigned int ESO; /* 24 bits (16 on DX) */
	unsigned int LBA; /* 30 bits */
	unsigned short EC; /* 12 bits */
	unsigned short Alpha; /* 12 bits */
	unsigned short Delta; /* 16 bits */
	unsigned short Attribute; /* 16 bits - SiS 7018 */
	unsigned short Vol; /* 12 bits (6.6) */
	unsigned char Pan; /* 7 bits (1.4.2) */
	unsigned char GVSel; /* 1 bit */
	unsigned char RVol; /* 7 bits (5.2) */
	unsigned char CVol; /* 7 bits (5.2) */
	unsigned char FMC; /* 2 bits */
	unsigned char CTRL; /* 4 bits */
	unsigned char FMS; /* 4 bits */
	unsigned char LFO; /* 8 bits */

	unsigned int negCSO; /* nonzero - use negative CSO */

	struct snd_util_memblk memblk; / memory block if TLB enabled */

	/* PCM data */

	struct snd_trident *trident;
	struct snd_pcm_substream *substream;
	struct snd_trident_voice extra; / extra PCM voice (acts as interrupt generator) */
	unsigned int running: 1,
	capture: 1,
	spdif: 1,
	foldback: 1,
	isync: 1,
	isync2: 1,
	isync3: 1;
	int foldback_chan; /* foldback subdevice number */
	unsigned int stimer; /* global sample timer (to detect spurious interrupts) */
	unsigned int spurious_threshold; /* spurious threshold */
	unsigned int isync_mark;
	unsigned int isync_max;
	unsigned int isync_ESO;

	/* --- */

	void *private_data;
	void (private_free)(struct snd_trident_voice voice);
	};

	struct snd_4dwave {
	int seq_client;

	struct snd_trident_port seq_ports[4];
	struct snd_trident_voice voices[64];

	int ChanSynthCount; /* number of allocated synth channels */
	int max_size; /* maximum synth memory size in bytes */
	int current_size; /* current allocated synth mem in bytes */
	};

	struct snd_trident_pcm_mixer {
	struct snd_trident_voice voice; / active voice */
	unsigned short vol; /* front volume */
	unsigned char pan; /* pan control */
	unsigned char rvol; /* rear volume */
	unsigned char cvol; /* center volume */
	unsigned char pad;
	};

	struct snd_trident {
	int irq;

	unsigned int device; /* device ID */

	unsigned char bDMAStart;

	unsigned long port;
	unsigned long midi_port;

	unsigned int spurious_irq_count;
	unsigned int spurious_irq_max_delta;

	struct snd_trident_tlb tlb; /* TLB entries for NX cards */

	unsigned char spdif_ctrl;
	unsigned char spdif_pcm_ctrl;
	unsigned int spdif_bits;
	unsigned int spdif_pcm_bits;
	struct snd_kcontrol spdif_pcm_ctl; / S/PDIF settings */
	unsigned int ac97_ctrl;

	unsigned int ChanMap[2]; /* allocation map for hardware channels */

	int ChanPCM; /* max number of PCM channels */
	int ChanPCMcnt; /* actual number of PCM channels */

	unsigned int ac97_detect: 1; /* 1 = AC97 in detection phase */
	unsigned int in_suspend: 1; /* 1 during suspend/resume */

	struct snd_4dwave synth; /* synth specific variables */

	spinlock_t event_lock;
	spinlock_t voice_alloc;

	struct snd_dma_device dma_dev;

	struct pci_dev *pci;
	struct snd_card *card;
	struct snd_pcm pcm; / ADC/DAC PCM */
	struct snd_pcm foldback; / Foldback PCM */
	struct snd_pcm spdif; / SPDIF PCM */
	struct snd_rawmidi *rmidi;

	struct snd_ac97_bus *ac97_bus;
	struct snd_ac97 *ac97;
	struct snd_ac97 *ac97_sec;

	unsigned int musicvol_wavevol;
	struct snd_trident_pcm_mixer pcm_mixer[32];
	struct snd_kcontrol ctl_vol; / front volume */
	struct snd_kcontrol ctl_pan; / pan */
	struct snd_kcontrol ctl_rvol; / rear volume */
	struct snd_kcontrol ctl_cvol; / center volume */

	spinlock_t reg_lock;

	struct gameport *gameport;
	};

	int snd_trident_create(struct snd_card *card,
	struct pci_dev *pci,
	int pcm_streams,
	int pcm_spdif_device,
	int max_wavetable_size);
	int snd_trident_create_gameport(struct snd_trident *trident);

	int snd_trident_pcm(struct snd_trident *trident, int device);
	int snd_trident_foldback_pcm(struct snd_trident *trident, int device);
	int snd_trident_spdif_pcm(struct snd_trident *trident, int device);
	struct snd_trident_voice snd_trident_alloc_voice(struct snd_trident trident, int type,
	int client, int port);
	void snd_trident_free_voice(struct snd_trident * trident, struct snd_trident_voice *voice);
	void snd_trident_start_voice(struct snd_trident * trident, unsigned int voice);
	void snd_trident_stop_voice(struct snd_trident * trident, unsigned int voice);
	void snd_trident_write_voice_regs(struct snd_trident * trident, struct snd_trident_voice *voice);
	extern const struct dev_pm_ops snd_trident_pm;

	/* TLB memory allocation */
	struct snd_util_memblk snd_trident_alloc_pages(struct snd_trident trident,
	struct snd_pcm_substream *substream);
	int snd_trident_free_pages(struct snd_trident trident, struct snd_util_memblk blk);

	#endif /* __SOUND_TRIDENT_H */