423 lines · c
1/* SPDX-License-Identifier: GPL-2.0-or-later */2#ifndef __SOUND_TRIDENT_H3#define __SOUND_TRIDENT_H4 5/*6 * audio@tridentmicro.com7 * Fri Feb 19 15:55:28 MST 19998 * Definitions for Trident 4DWave DX/NX chips9 */10 11#include <sound/pcm.h>12#include <sound/mpu401.h>13#include <sound/ac97_codec.h>14#include <sound/util_mem.h>15 16#define TRIDENT_DEVICE_ID_DX ((PCI_VENDOR_ID_TRIDENT<<16)|PCI_DEVICE_ID_TRIDENT_4DWAVE_DX)17#define TRIDENT_DEVICE_ID_NX ((PCI_VENDOR_ID_TRIDENT<<16)|PCI_DEVICE_ID_TRIDENT_4DWAVE_NX)18#define TRIDENT_DEVICE_ID_SI7018 ((PCI_VENDOR_ID_SI<<16)|PCI_DEVICE_ID_SI_7018)19 20#define SNDRV_TRIDENT_VOICE_TYPE_PCM 021#define SNDRV_TRIDENT_VOICE_TYPE_SYNTH 122#define SNDRV_TRIDENT_VOICE_TYPE_MIDI 223 24#define SNDRV_TRIDENT_VFLG_RUNNING (1<<0)25 26/* TLB code constants */27#define SNDRV_TRIDENT_PAGE_SIZE 409628#define SNDRV_TRIDENT_PAGE_SHIFT 1229#define SNDRV_TRIDENT_PAGE_MASK ((1<<SNDRV_TRIDENT_PAGE_SHIFT)-1)30#define SNDRV_TRIDENT_MAX_PAGES 409631 32/*33 * Direct registers34 */35 36#define TRID_REG(trident, x) ((trident)->port + (x))37 38#define ID_4DWAVE_DX 0x200039#define ID_4DWAVE_NX 0x200140 41/* Bank definitions */42 43#define T4D_BANK_A 044#define T4D_BANK_B 145#define T4D_NUM_BANKS 246 47/* Register definitions */48 49/* Global registers */50 51enum global_control_bits {52 CHANNEL_IDX = 0x0000003f,53 OVERRUN_IE = 0x00000400, /* interrupt enable: capture overrun */54 UNDERRUN_IE = 0x00000800, /* interrupt enable: playback underrun */55 ENDLP_IE = 0x00001000, /* interrupt enable: end of buffer */56 MIDLP_IE = 0x00002000, /* interrupt enable: middle buffer */57 ETOG_IE = 0x00004000, /* interrupt enable: envelope toggling */58 EDROP_IE = 0x00008000, /* interrupt enable: envelope drop */59 BANK_B_EN = 0x00010000, /* SiS: enable bank B (64 channels) */60 PCMIN_B_MIX = 0x00020000, /* SiS: PCM IN B mixing enable */61 I2S_OUT_ASSIGN = 0x00040000, /* SiS: I2S Out contains surround PCM */62 SPDIF_OUT_ASSIGN= 0x00080000, /* SiS: 0=S/PDIF L/R | 1=PCM Out FIFO */63 MAIN_OUT_ASSIGN = 0x00100000, /* SiS: 0=PCM Out FIFO | 1=MMC Out buffer */64};65 66enum miscint_bits {67 PB_UNDERRUN_IRQ = 0x00000001, REC_OVERRUN_IRQ = 0x00000002,68 SB_IRQ = 0x00000004, MPU401_IRQ = 0x00000008,69 OPL3_IRQ = 0x00000010, ADDRESS_IRQ = 0x00000020,70 ENVELOPE_IRQ = 0x00000040, PB_UNDERRUN = 0x00000100,71 REC_OVERRUN = 0x00000200, MIXER_UNDERFLOW = 0x00000400,72 MIXER_OVERFLOW = 0x00000800, NX_SB_IRQ_DISABLE = 0x00001000,73 ST_TARGET_REACHED = 0x00008000,74 PB_24K_MODE = 0x00010000, ST_IRQ_EN = 0x00800000,75 ACGPIO_IRQ = 0x0100000076};77 78/* T2 legacy dma control registers. */79#define LEGACY_DMAR0 0x00 // ADR080#define LEGACY_DMAR4 0x04 // CNT081#define LEGACY_DMAR6 0x06 // CNT0 - High bits82#define LEGACY_DMAR11 0x0b // MOD 83#define LEGACY_DMAR15 0x0f // MMR 84 85#define T4D_START_A 0x8086#define T4D_STOP_A 0x8487#define T4D_DLY_A 0x8888#define T4D_SIGN_CSO_A 0x8c89#define T4D_CSPF_A 0x9090#define T4D_CSPF_B 0xbc91#define T4D_CEBC_A 0x9492#define T4D_AINT_A 0x9893#define T4D_AINTEN_A 0x9c94#define T4D_LFO_GC_CIR 0xa095#define T4D_MUSICVOL_WAVEVOL 0xa896#define T4D_SBDELTA_DELTA_R 0xac97#define T4D_MISCINT 0xb098#define T4D_START_B 0xb499#define T4D_STOP_B 0xb8100#define T4D_SBBL_SBCL 0xc0101#define T4D_SBCTRL_SBE2R_SBDD 0xc4102#define T4D_STIMER 0xc8103#define T4D_AINT_B 0xd8104#define T4D_AINTEN_B 0xdc105#define T4D_RCI 0x70106 107/* MPU-401 UART */108#define T4D_MPU401_BASE 0x20109#define T4D_MPUR0 0x20110#define T4D_MPUR1 0x21111#define T4D_MPUR2 0x22112#define T4D_MPUR3 0x23113 114/* S/PDIF Registers */115#define NX_SPCTRL_SPCSO 0x24116#define NX_SPLBA 0x28117#define NX_SPESO 0x2c118#define NX_SPCSTATUS 0x64119 120/* Joystick */121#define GAMEPORT_GCR 0x30122#define GAMEPORT_MODE_ADC 0x80123#define GAMEPORT_LEGACY 0x31124#define GAMEPORT_AXES 0x34125 126/* NX Specific Registers */127#define NX_TLBC 0x6c128 129/* Channel Registers */130 131#define CH_START 0xe0132 133#define CH_DX_CSO_ALPHA_FMS 0xe0134#define CH_DX_ESO_DELTA 0xe8135#define CH_DX_FMC_RVOL_CVOL 0xec136 137#define CH_NX_DELTA_CSO 0xe0138#define CH_NX_DELTA_ESO 0xe8139#define CH_NX_ALPHA_FMS_FMC_RVOL_CVOL 0xec140 141#define CH_LBA 0xe4142#define CH_GVSEL_PAN_VOL_CTRL_EC 0xf0143#define CH_EBUF1 0xf4144#define CH_EBUF2 0xf8145 146/* AC-97 Registers */147 148#define DX_ACR0_AC97_W 0x40149#define DX_ACR1_AC97_R 0x44150#define DX_ACR2_AC97_COM_STAT 0x48151 152#define NX_ACR0_AC97_COM_STAT 0x40153#define NX_ACR1_AC97_W 0x44154#define NX_ACR2_AC97_R_PRIMARY 0x48155#define NX_ACR3_AC97_R_SECONDARY 0x4c156 157#define SI_AC97_WRITE 0x40158#define SI_AC97_READ 0x44159#define SI_SERIAL_INTF_CTRL 0x48160#define SI_AC97_GPIO 0x4c161#define SI_ASR0 0x50162#define SI_SPDIF_CS 0x70163#define SI_GPIO 0x7c164 165enum trident_nx_ac97_bits {166 /* ACR1-3 */167 NX_AC97_BUSY_WRITE = 0x0800,168 NX_AC97_BUSY_READ = 0x0800,169 NX_AC97_BUSY_DATA = 0x0400,170 NX_AC97_WRITE_SECONDARY = 0x0100,171 /* ACR0 */172 NX_AC97_SECONDARY_READY = 0x0040,173 NX_AC97_SECONDARY_RECORD = 0x0020,174 NX_AC97_SURROUND_OUTPUT = 0x0010,175 NX_AC97_PRIMARY_READY = 0x0008,176 NX_AC97_PRIMARY_RECORD = 0x0004,177 NX_AC97_PCM_OUTPUT = 0x0002,178 NX_AC97_WARM_RESET = 0x0001179};180 181enum trident_dx_ac97_bits {182 DX_AC97_BUSY_WRITE = 0x8000,183 DX_AC97_BUSY_READ = 0x8000,184 DX_AC97_READY = 0x0010,185 DX_AC97_RECORD = 0x0008,186 DX_AC97_PLAYBACK = 0x0002187};188 189enum sis7018_ac97_bits {190 SI_AC97_BUSY_WRITE = 0x00008000,191 SI_AC97_AUDIO_BUSY = 0x00004000,192 SI_AC97_MODEM_BUSY = 0x00002000,193 SI_AC97_BUSY_READ = 0x00008000,194 SI_AC97_SECONDARY = 0x00000080,195};196 197enum serial_intf_ctrl_bits {198 WARM_RESET = 0x00000001,199 COLD_RESET = 0x00000002,200 I2S_CLOCK = 0x00000004,201 PCM_SEC_AC97 = 0x00000008,202 AC97_DBL_RATE = 0x00000010,203 SPDIF_EN = 0x00000020,204 I2S_OUTPUT_EN = 0x00000040,205 I2S_INPUT_EN = 0x00000080,206 PCMIN = 0x00000100,207 LINE1IN = 0x00000200,208 MICIN = 0x00000400,209 LINE2IN = 0x00000800,210 HEAD_SET_IN = 0x00001000,211 GPIOIN = 0x00002000,212 /* 7018 spec says id = 01 but the demo board routed to 10213 SECONDARY_ID= 0x00004000, */214 SECONDARY_ID = 0x00004000,215 PCMOUT = 0x00010000,216 SURROUT = 0x00020000,217 CENTEROUT = 0x00040000,218 LFEOUT = 0x00080000,219 LINE1OUT = 0x00100000,220 LINE2OUT = 0x00200000,221 GPIOOUT = 0x00400000,222 SI_AC97_PRIMARY_READY = 0x01000000,223 SI_AC97_SECONDARY_READY = 0x02000000,224 SI_AC97_POWERDOWN = 0x04000000,225};226 227/* PCM defaults */228 229#define T4D_DEFAULT_PCM_VOL 10 /* 0 - 255 */230#define T4D_DEFAULT_PCM_PAN 0 /* 0 - 127 */231#define T4D_DEFAULT_PCM_RVOL 127 /* 0 - 127 */232#define T4D_DEFAULT_PCM_CVOL 127 /* 0 - 127 */233 234struct snd_trident;235struct snd_trident_voice;236struct snd_trident_pcm_mixer;237 238struct snd_trident_port {239 struct snd_midi_channel_set * chset;240 struct snd_trident * trident;241 int mode; /* operation mode */242 int client; /* sequencer client number */243 int port; /* sequencer port number */244 unsigned int midi_has_voices: 1;245};246 247struct snd_trident_memblk_arg {248 short first_page, last_page;249};250 251struct snd_trident_tlb {252 __le32 *entries; /* 16k-aligned TLB table */253 dma_addr_t entries_dmaaddr; /* 16k-aligned PCI address to TLB table */254 struct snd_dma_buffer *buffer;255 struct snd_util_memhdr * memhdr; /* page allocation list */256 struct snd_dma_buffer *silent_page;257};258 259struct snd_trident_voice {260 unsigned int number;261 unsigned int use: 1,262 pcm: 1,263 synth:1,264 midi: 1;265 unsigned int flags;266 unsigned char client;267 unsigned char port;268 unsigned char index;269 270 struct snd_trident_sample_ops *sample_ops;271 272 /* channel parameters */273 unsigned int CSO; /* 24 bits (16 on DX) */274 unsigned int ESO; /* 24 bits (16 on DX) */275 unsigned int LBA; /* 30 bits */276 unsigned short EC; /* 12 bits */277 unsigned short Alpha; /* 12 bits */278 unsigned short Delta; /* 16 bits */279 unsigned short Attribute; /* 16 bits - SiS 7018 */280 unsigned short Vol; /* 12 bits (6.6) */281 unsigned char Pan; /* 7 bits (1.4.2) */282 unsigned char GVSel; /* 1 bit */283 unsigned char RVol; /* 7 bits (5.2) */284 unsigned char CVol; /* 7 bits (5.2) */285 unsigned char FMC; /* 2 bits */286 unsigned char CTRL; /* 4 bits */287 unsigned char FMS; /* 4 bits */288 unsigned char LFO; /* 8 bits */289 290 unsigned int negCSO; /* nonzero - use negative CSO */291 292 struct snd_util_memblk *memblk; /* memory block if TLB enabled */293 294 /* PCM data */295 296 struct snd_trident *trident;297 struct snd_pcm_substream *substream;298 struct snd_trident_voice *extra; /* extra PCM voice (acts as interrupt generator) */299 unsigned int running: 1,300 capture: 1,301 spdif: 1,302 foldback: 1,303 isync: 1,304 isync2: 1,305 isync3: 1;306 int foldback_chan; /* foldback subdevice number */307 unsigned int stimer; /* global sample timer (to detect spurious interrupts) */308 unsigned int spurious_threshold; /* spurious threshold */309 unsigned int isync_mark;310 unsigned int isync_max;311 unsigned int isync_ESO;312 313 /* --- */314 315 void *private_data;316 void (*private_free)(struct snd_trident_voice *voice);317};318 319struct snd_4dwave {320 int seq_client;321 322 struct snd_trident_port seq_ports[4];323 struct snd_trident_voice voices[64]; 324 325 int ChanSynthCount; /* number of allocated synth channels */326 int max_size; /* maximum synth memory size in bytes */327 int current_size; /* current allocated synth mem in bytes */328};329 330struct snd_trident_pcm_mixer {331 struct snd_trident_voice *voice; /* active voice */332 unsigned short vol; /* front volume */333 unsigned char pan; /* pan control */334 unsigned char rvol; /* rear volume */335 unsigned char cvol; /* center volume */336 unsigned char pad;337};338 339struct snd_trident {340 int irq;341 342 unsigned int device; /* device ID */343 344 unsigned char bDMAStart;345 346 unsigned long port;347 unsigned long midi_port;348 349 unsigned int spurious_irq_count;350 unsigned int spurious_irq_max_delta;351 352 struct snd_trident_tlb tlb; /* TLB entries for NX cards */353 354 unsigned char spdif_ctrl;355 unsigned char spdif_pcm_ctrl;356 unsigned int spdif_bits;357 unsigned int spdif_pcm_bits;358 struct snd_kcontrol *spdif_pcm_ctl; /* S/PDIF settings */359 unsigned int ac97_ctrl;360 361 unsigned int ChanMap[2]; /* allocation map for hardware channels */362 363 int ChanPCM; /* max number of PCM channels */364 int ChanPCMcnt; /* actual number of PCM channels */365 366 unsigned int ac97_detect: 1; /* 1 = AC97 in detection phase */367 unsigned int in_suspend: 1; /* 1 during suspend/resume */368 369 struct snd_4dwave synth; /* synth specific variables */370 371 spinlock_t event_lock;372 spinlock_t voice_alloc;373 374 struct snd_dma_device dma_dev;375 376 struct pci_dev *pci;377 struct snd_card *card;378 struct snd_pcm *pcm; /* ADC/DAC PCM */379 struct snd_pcm *foldback; /* Foldback PCM */380 struct snd_pcm *spdif; /* SPDIF PCM */381 struct snd_rawmidi *rmidi;382 383 struct snd_ac97_bus *ac97_bus;384 struct snd_ac97 *ac97;385 struct snd_ac97 *ac97_sec;386 387 unsigned int musicvol_wavevol;388 struct snd_trident_pcm_mixer pcm_mixer[32];389 struct snd_kcontrol *ctl_vol; /* front volume */390 struct snd_kcontrol *ctl_pan; /* pan */391 struct snd_kcontrol *ctl_rvol; /* rear volume */392 struct snd_kcontrol *ctl_cvol; /* center volume */393 394 spinlock_t reg_lock;395 396 struct gameport *gameport;397};398 399int snd_trident_create(struct snd_card *card,400 struct pci_dev *pci,401 int pcm_streams,402 int pcm_spdif_device,403 int max_wavetable_size);404int snd_trident_create_gameport(struct snd_trident *trident);405 406int snd_trident_pcm(struct snd_trident *trident, int device);407int snd_trident_foldback_pcm(struct snd_trident *trident, int device);408int snd_trident_spdif_pcm(struct snd_trident *trident, int device);409struct snd_trident_voice *snd_trident_alloc_voice(struct snd_trident * trident, int type,410 int client, int port);411void snd_trident_free_voice(struct snd_trident * trident, struct snd_trident_voice *voice);412void snd_trident_start_voice(struct snd_trident * trident, unsigned int voice);413void snd_trident_stop_voice(struct snd_trident * trident, unsigned int voice);414void snd_trident_write_voice_regs(struct snd_trident * trident, struct snd_trident_voice *voice);415extern const struct dev_pm_ops snd_trident_pm;416 417/* TLB memory allocation */418struct snd_util_memblk *snd_trident_alloc_pages(struct snd_trident *trident,419 struct snd_pcm_substream *substream);420int snd_trident_free_pages(struct snd_trident *trident, struct snd_util_memblk *blk);421 422#endif /* __SOUND_TRIDENT_H */423