1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun #ifndef __SOUND_GUS_H
3*4882a593Smuzhiyun #define __SOUND_GUS_H
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun /*
6*4882a593Smuzhiyun * Global structures used for GUS part of ALSA driver
7*4882a593Smuzhiyun * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
8*4882a593Smuzhiyun */
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include <sound/pcm.h>
11*4882a593Smuzhiyun #include <sound/rawmidi.h>
12*4882a593Smuzhiyun #include <sound/timer.h>
13*4882a593Smuzhiyun #include <sound/seq_midi_emul.h>
14*4882a593Smuzhiyun #include <sound/seq_device.h>
15*4882a593Smuzhiyun #include <linux/io.h>
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun /* IO ports */
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun #define GUSP(gus, x) ((gus)->gf1.port + SNDRV_g_u_s_##x)
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun #define SNDRV_g_u_s_MIDICTRL (0x320-0x220)
22*4882a593Smuzhiyun #define SNDRV_g_u_s_MIDISTAT (0x320-0x220)
23*4882a593Smuzhiyun #define SNDRV_g_u_s_MIDIDATA (0x321-0x220)
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun #define SNDRV_g_u_s_GF1PAGE (0x322-0x220)
26*4882a593Smuzhiyun #define SNDRV_g_u_s_GF1REGSEL (0x323-0x220)
27*4882a593Smuzhiyun #define SNDRV_g_u_s_GF1DATALOW (0x324-0x220)
28*4882a593Smuzhiyun #define SNDRV_g_u_s_GF1DATAHIGH (0x325-0x220)
29*4882a593Smuzhiyun #define SNDRV_g_u_s_IRQSTAT (0x226-0x220)
30*4882a593Smuzhiyun #define SNDRV_g_u_s_TIMERCNTRL (0x228-0x220)
31*4882a593Smuzhiyun #define SNDRV_g_u_s_TIMERDATA (0x229-0x220)
32*4882a593Smuzhiyun #define SNDRV_g_u_s_DRAM (0x327-0x220)
33*4882a593Smuzhiyun #define SNDRV_g_u_s_MIXCNTRLREG (0x220-0x220)
34*4882a593Smuzhiyun #define SNDRV_g_u_s_IRQDMACNTRLREG (0x22b-0x220)
35*4882a593Smuzhiyun #define SNDRV_g_u_s_REGCNTRLS (0x22f-0x220)
36*4882a593Smuzhiyun #define SNDRV_g_u_s_BOARDVERSION (0x726-0x220)
37*4882a593Smuzhiyun #define SNDRV_g_u_s_MIXCNTRLPORT (0x726-0x220)
38*4882a593Smuzhiyun #define SNDRV_g_u_s_IVER (0x325-0x220)
39*4882a593Smuzhiyun #define SNDRV_g_u_s_MIXDATAPORT (0x326-0x220)
40*4882a593Smuzhiyun #define SNDRV_g_u_s_MAXCNTRLPORT (0x326-0x220)
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun /* GF1 registers */
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun /* global registers */
45*4882a593Smuzhiyun #define SNDRV_GF1_GB_ACTIVE_VOICES 0x0e
46*4882a593Smuzhiyun #define SNDRV_GF1_GB_VOICES_IRQ 0x0f
47*4882a593Smuzhiyun #define SNDRV_GF1_GB_GLOBAL_MODE 0x19
48*4882a593Smuzhiyun #define SNDRV_GF1_GW_LFO_BASE 0x1a
49*4882a593Smuzhiyun #define SNDRV_GF1_GB_VOICES_IRQ_READ 0x1f
50*4882a593Smuzhiyun #define SNDRV_GF1_GB_DRAM_DMA_CONTROL 0x41
51*4882a593Smuzhiyun #define SNDRV_GF1_GW_DRAM_DMA_LOW 0x42
52*4882a593Smuzhiyun #define SNDRV_GF1_GW_DRAM_IO_LOW 0x43
53*4882a593Smuzhiyun #define SNDRV_GF1_GB_DRAM_IO_HIGH 0x44
54*4882a593Smuzhiyun #define SNDRV_GF1_GB_SOUND_BLASTER_CONTROL 0x45
55*4882a593Smuzhiyun #define SNDRV_GF1_GB_ADLIB_TIMER_1 0x46
56*4882a593Smuzhiyun #define SNDRV_GF1_GB_ADLIB_TIMER_2 0x47
57*4882a593Smuzhiyun #define SNDRV_GF1_GB_RECORD_RATE 0x48
58*4882a593Smuzhiyun #define SNDRV_GF1_GB_REC_DMA_CONTROL 0x49
59*4882a593Smuzhiyun #define SNDRV_GF1_GB_JOYSTICK_DAC_LEVEL 0x4b
60*4882a593Smuzhiyun #define SNDRV_GF1_GB_RESET 0x4c
61*4882a593Smuzhiyun #define SNDRV_GF1_GB_DRAM_DMA_HIGH 0x50
62*4882a593Smuzhiyun #define SNDRV_GF1_GW_DRAM_IO16 0x51
63*4882a593Smuzhiyun #define SNDRV_GF1_GW_MEMORY_CONFIG 0x52
64*4882a593Smuzhiyun #define SNDRV_GF1_GB_MEMORY_CONTROL 0x53
65*4882a593Smuzhiyun #define SNDRV_GF1_GW_FIFO_RECORD_BASE_ADDR 0x54
66*4882a593Smuzhiyun #define SNDRV_GF1_GW_FIFO_PLAY_BASE_ADDR 0x55
67*4882a593Smuzhiyun #define SNDRV_GF1_GW_FIFO_SIZE 0x56
68*4882a593Smuzhiyun #define SNDRV_GF1_GW_INTERLEAVE 0x57
69*4882a593Smuzhiyun #define SNDRV_GF1_GB_COMPATIBILITY 0x59
70*4882a593Smuzhiyun #define SNDRV_GF1_GB_DECODE_CONTROL 0x5a
71*4882a593Smuzhiyun #define SNDRV_GF1_GB_VERSION_NUMBER 0x5b
72*4882a593Smuzhiyun #define SNDRV_GF1_GB_MPU401_CONTROL_A 0x5c
73*4882a593Smuzhiyun #define SNDRV_GF1_GB_MPU401_CONTROL_B 0x5d
74*4882a593Smuzhiyun #define SNDRV_GF1_GB_EMULATION_IRQ 0x60
75*4882a593Smuzhiyun /* voice specific registers */
76*4882a593Smuzhiyun #define SNDRV_GF1_VB_ADDRESS_CONTROL 0x00
77*4882a593Smuzhiyun #define SNDRV_GF1_VW_FREQUENCY 0x01
78*4882a593Smuzhiyun #define SNDRV_GF1_VW_START_HIGH 0x02
79*4882a593Smuzhiyun #define SNDRV_GF1_VW_START_LOW 0x03
80*4882a593Smuzhiyun #define SNDRV_GF1_VA_START SNDRV_GF1_VW_START_HIGH
81*4882a593Smuzhiyun #define SNDRV_GF1_VW_END_HIGH 0x04
82*4882a593Smuzhiyun #define SNDRV_GF1_VW_END_LOW 0x05
83*4882a593Smuzhiyun #define SNDRV_GF1_VA_END SNDRV_GF1_VW_END_HIGH
84*4882a593Smuzhiyun #define SNDRV_GF1_VB_VOLUME_RATE 0x06
85*4882a593Smuzhiyun #define SNDRV_GF1_VB_VOLUME_START 0x07
86*4882a593Smuzhiyun #define SNDRV_GF1_VB_VOLUME_END 0x08
87*4882a593Smuzhiyun #define SNDRV_GF1_VW_VOLUME 0x09
88*4882a593Smuzhiyun #define SNDRV_GF1_VW_CURRENT_HIGH 0x0a
89*4882a593Smuzhiyun #define SNDRV_GF1_VW_CURRENT_LOW 0x0b
90*4882a593Smuzhiyun #define SNDRV_GF1_VA_CURRENT SNDRV_GF1_VW_CURRENT_HIGH
91*4882a593Smuzhiyun #define SNDRV_GF1_VB_PAN 0x0c
92*4882a593Smuzhiyun #define SNDRV_GF1_VW_OFFSET_RIGHT 0x0c
93*4882a593Smuzhiyun #define SNDRV_GF1_VB_VOLUME_CONTROL 0x0d
94*4882a593Smuzhiyun #define SNDRV_GF1_VB_UPPER_ADDRESS 0x10
95*4882a593Smuzhiyun #define SNDRV_GF1_VW_EFFECT_HIGH 0x11
96*4882a593Smuzhiyun #define SNDRV_GF1_VW_EFFECT_LOW 0x12
97*4882a593Smuzhiyun #define SNDRV_GF1_VA_EFFECT SNDRV_GF1_VW_EFFECT_HIGH
98*4882a593Smuzhiyun #define SNDRV_GF1_VW_OFFSET_LEFT 0x13
99*4882a593Smuzhiyun #define SNDRV_GF1_VB_ACCUMULATOR 0x14
100*4882a593Smuzhiyun #define SNDRV_GF1_VB_MODE 0x15
101*4882a593Smuzhiyun #define SNDRV_GF1_VW_EFFECT_VOLUME 0x16
102*4882a593Smuzhiyun #define SNDRV_GF1_VB_FREQUENCY_LFO 0x17
103*4882a593Smuzhiyun #define SNDRV_GF1_VB_VOLUME_LFO 0x18
104*4882a593Smuzhiyun #define SNDRV_GF1_VW_OFFSET_RIGHT_FINAL 0x1b
105*4882a593Smuzhiyun #define SNDRV_GF1_VW_OFFSET_LEFT_FINAL 0x1c
106*4882a593Smuzhiyun #define SNDRV_GF1_VW_EFFECT_VOLUME_FINAL 0x1d
107*4882a593Smuzhiyun
108*4882a593Smuzhiyun /* ICS registers */
109*4882a593Smuzhiyun
110*4882a593Smuzhiyun #define SNDRV_ICS_MIC_DEV 0
111*4882a593Smuzhiyun #define SNDRV_ICS_LINE_DEV 1
112*4882a593Smuzhiyun #define SNDRV_ICS_CD_DEV 2
113*4882a593Smuzhiyun #define SNDRV_ICS_GF1_DEV 3
114*4882a593Smuzhiyun #define SNDRV_ICS_NONE_DEV 4
115*4882a593Smuzhiyun #define SNDRV_ICS_MASTER_DEV 5
116*4882a593Smuzhiyun
117*4882a593Smuzhiyun /* LFO */
118*4882a593Smuzhiyun
119*4882a593Smuzhiyun #define SNDRV_LFO_TREMOLO 0
120*4882a593Smuzhiyun #define SNDRV_LFO_VIBRATO 1
121*4882a593Smuzhiyun
122*4882a593Smuzhiyun /* misc */
123*4882a593Smuzhiyun
124*4882a593Smuzhiyun #define SNDRV_GF1_DMA_UNSIGNED 0x80
125*4882a593Smuzhiyun #define SNDRV_GF1_DMA_16BIT 0x40
126*4882a593Smuzhiyun #define SNDRV_GF1_DMA_IRQ 0x20
127*4882a593Smuzhiyun #define SNDRV_GF1_DMA_WIDTH16 0x04
128*4882a593Smuzhiyun #define SNDRV_GF1_DMA_READ 0x02 /* read from GUS's DRAM */
129*4882a593Smuzhiyun #define SNDRV_GF1_DMA_ENABLE 0x01
130*4882a593Smuzhiyun
131*4882a593Smuzhiyun /* ramp ranges */
132*4882a593Smuzhiyun
133*4882a593Smuzhiyun #define SNDRV_GF1_ATTEN(x) (snd_gf1_atten_table[x])
134*4882a593Smuzhiyun #define SNDRV_GF1_MIN_VOLUME 1800
135*4882a593Smuzhiyun #define SNDRV_GF1_MAX_VOLUME 4095
136*4882a593Smuzhiyun #define SNDRV_GF1_MIN_OFFSET (SNDRV_GF1_MIN_VOLUME>>4)
137*4882a593Smuzhiyun #define SNDRV_GF1_MAX_OFFSET 255
138*4882a593Smuzhiyun #define SNDRV_GF1_MAX_TDEPTH 90
139*4882a593Smuzhiyun
140*4882a593Smuzhiyun /* defines for memory manager */
141*4882a593Smuzhiyun
142*4882a593Smuzhiyun #define SNDRV_GF1_MEM_BLOCK_16BIT 0x0001
143*4882a593Smuzhiyun
144*4882a593Smuzhiyun #define SNDRV_GF1_MEM_OWNER_DRIVER 0x0001
145*4882a593Smuzhiyun #define SNDRV_GF1_MEM_OWNER_WAVE_SIMPLE 0x0002
146*4882a593Smuzhiyun #define SNDRV_GF1_MEM_OWNER_WAVE_GF1 0x0003
147*4882a593Smuzhiyun #define SNDRV_GF1_MEM_OWNER_WAVE_IWFFFF 0x0004
148*4882a593Smuzhiyun
149*4882a593Smuzhiyun /* constants for interrupt handlers */
150*4882a593Smuzhiyun
151*4882a593Smuzhiyun #define SNDRV_GF1_HANDLER_MIDI_OUT 0x00010000
152*4882a593Smuzhiyun #define SNDRV_GF1_HANDLER_MIDI_IN 0x00020000
153*4882a593Smuzhiyun #define SNDRV_GF1_HANDLER_TIMER1 0x00040000
154*4882a593Smuzhiyun #define SNDRV_GF1_HANDLER_TIMER2 0x00080000
155*4882a593Smuzhiyun #define SNDRV_GF1_HANDLER_VOICE 0x00100000
156*4882a593Smuzhiyun #define SNDRV_GF1_HANDLER_DMA_WRITE 0x00200000
157*4882a593Smuzhiyun #define SNDRV_GF1_HANDLER_DMA_READ 0x00400000
158*4882a593Smuzhiyun #define SNDRV_GF1_HANDLER_ALL (0xffff0000&~SNDRV_GF1_HANDLER_VOICE)
159*4882a593Smuzhiyun
160*4882a593Smuzhiyun /* constants for DMA flags */
161*4882a593Smuzhiyun
162*4882a593Smuzhiyun #define SNDRV_GF1_DMA_TRIGGER 1
163*4882a593Smuzhiyun
164*4882a593Smuzhiyun /* --- */
165*4882a593Smuzhiyun
166*4882a593Smuzhiyun struct snd_gus_card;
167*4882a593Smuzhiyun
168*4882a593Smuzhiyun /* GF1 specific structure */
169*4882a593Smuzhiyun
170*4882a593Smuzhiyun struct snd_gf1_bank_info {
171*4882a593Smuzhiyun unsigned int address;
172*4882a593Smuzhiyun unsigned int size;
173*4882a593Smuzhiyun };
174*4882a593Smuzhiyun
175*4882a593Smuzhiyun struct snd_gf1_mem_block {
176*4882a593Smuzhiyun unsigned short flags; /* flags - SNDRV_GF1_MEM_BLOCK_XXXX */
177*4882a593Smuzhiyun unsigned short owner; /* owner - SNDRV_GF1_MEM_OWNER_XXXX */
178*4882a593Smuzhiyun unsigned int share; /* share count */
179*4882a593Smuzhiyun unsigned int share_id[4]; /* share ID */
180*4882a593Smuzhiyun unsigned int ptr;
181*4882a593Smuzhiyun unsigned int size;
182*4882a593Smuzhiyun char *name;
183*4882a593Smuzhiyun struct snd_gf1_mem_block *next;
184*4882a593Smuzhiyun struct snd_gf1_mem_block *prev;
185*4882a593Smuzhiyun };
186*4882a593Smuzhiyun
187*4882a593Smuzhiyun struct snd_gf1_mem {
188*4882a593Smuzhiyun struct snd_gf1_bank_info banks_8[4];
189*4882a593Smuzhiyun struct snd_gf1_bank_info banks_16[4];
190*4882a593Smuzhiyun struct snd_gf1_mem_block *first;
191*4882a593Smuzhiyun struct snd_gf1_mem_block *last;
192*4882a593Smuzhiyun struct mutex memory_mutex;
193*4882a593Smuzhiyun };
194*4882a593Smuzhiyun
195*4882a593Smuzhiyun struct snd_gf1_dma_block {
196*4882a593Smuzhiyun void *buffer; /* buffer in computer's RAM */
197*4882a593Smuzhiyun unsigned long buf_addr; /* buffer address */
198*4882a593Smuzhiyun unsigned int addr; /* address in onboard memory */
199*4882a593Smuzhiyun unsigned int count; /* count in bytes */
200*4882a593Smuzhiyun unsigned int cmd; /* DMA command (format) */
201*4882a593Smuzhiyun void (*ack)(struct snd_gus_card * gus, void *private_data);
202*4882a593Smuzhiyun void *private_data;
203*4882a593Smuzhiyun struct snd_gf1_dma_block *next;
204*4882a593Smuzhiyun };
205*4882a593Smuzhiyun
206*4882a593Smuzhiyun struct snd_gus_port {
207*4882a593Smuzhiyun struct snd_midi_channel_set * chset;
208*4882a593Smuzhiyun struct snd_gus_card * gus;
209*4882a593Smuzhiyun int mode; /* operation mode */
210*4882a593Smuzhiyun int client; /* sequencer client number */
211*4882a593Smuzhiyun int port; /* sequencer port number */
212*4882a593Smuzhiyun unsigned int midi_has_voices: 1;
213*4882a593Smuzhiyun };
214*4882a593Smuzhiyun
215*4882a593Smuzhiyun struct snd_gus_voice;
216*4882a593Smuzhiyun
217*4882a593Smuzhiyun #define SNDRV_GF1_VOICE_TYPE_PCM 0
218*4882a593Smuzhiyun #define SNDRV_GF1_VOICE_TYPE_SYNTH 1
219*4882a593Smuzhiyun #define SNDRV_GF1_VOICE_TYPE_MIDI 2
220*4882a593Smuzhiyun
221*4882a593Smuzhiyun #define SNDRV_GF1_VFLG_RUNNING (1<<0)
222*4882a593Smuzhiyun #define SNDRV_GF1_VFLG_EFFECT_TIMER1 (1<<1)
223*4882a593Smuzhiyun #define SNDRV_GF1_VFLG_PAN (1<<2)
224*4882a593Smuzhiyun
225*4882a593Smuzhiyun enum snd_gus_volume_state {
226*4882a593Smuzhiyun VENV_BEFORE,
227*4882a593Smuzhiyun VENV_ATTACK,
228*4882a593Smuzhiyun VENV_SUSTAIN,
229*4882a593Smuzhiyun VENV_RELEASE,
230*4882a593Smuzhiyun VENV_DONE,
231*4882a593Smuzhiyun VENV_VOLUME
232*4882a593Smuzhiyun };
233*4882a593Smuzhiyun
234*4882a593Smuzhiyun struct snd_gus_voice {
235*4882a593Smuzhiyun int number;
236*4882a593Smuzhiyun unsigned int use: 1,
237*4882a593Smuzhiyun pcm: 1,
238*4882a593Smuzhiyun synth:1,
239*4882a593Smuzhiyun midi: 1;
240*4882a593Smuzhiyun unsigned int flags;
241*4882a593Smuzhiyun unsigned char client;
242*4882a593Smuzhiyun unsigned char port;
243*4882a593Smuzhiyun unsigned char index;
244*4882a593Smuzhiyun unsigned char pad;
245*4882a593Smuzhiyun
246*4882a593Smuzhiyun #ifdef CONFIG_SND_DEBUG
247*4882a593Smuzhiyun unsigned int interrupt_stat_wave;
248*4882a593Smuzhiyun unsigned int interrupt_stat_volume;
249*4882a593Smuzhiyun #endif
250*4882a593Smuzhiyun void (*handler_wave) (struct snd_gus_card * gus, struct snd_gus_voice * voice);
251*4882a593Smuzhiyun void (*handler_volume) (struct snd_gus_card * gus, struct snd_gus_voice * voice);
252*4882a593Smuzhiyun void (*handler_effect) (struct snd_gus_card * gus, struct snd_gus_voice * voice);
253*4882a593Smuzhiyun void (*volume_change) (struct snd_gus_card * gus);
254*4882a593Smuzhiyun
255*4882a593Smuzhiyun struct snd_gus_sample_ops *sample_ops;
256*4882a593Smuzhiyun
257*4882a593Smuzhiyun /* running status / registers */
258*4882a593Smuzhiyun
259*4882a593Smuzhiyun unsigned short fc_register;
260*4882a593Smuzhiyun unsigned short fc_lfo;
261*4882a593Smuzhiyun unsigned short gf1_volume;
262*4882a593Smuzhiyun unsigned char control;
263*4882a593Smuzhiyun unsigned char mode;
264*4882a593Smuzhiyun unsigned char gf1_pan;
265*4882a593Smuzhiyun unsigned char effect_accumulator;
266*4882a593Smuzhiyun unsigned char volume_control;
267*4882a593Smuzhiyun unsigned char venv_value_next;
268*4882a593Smuzhiyun enum snd_gus_volume_state venv_state;
269*4882a593Smuzhiyun enum snd_gus_volume_state venv_state_prev;
270*4882a593Smuzhiyun unsigned short vlo;
271*4882a593Smuzhiyun unsigned short vro;
272*4882a593Smuzhiyun unsigned short gf1_effect_volume;
273*4882a593Smuzhiyun
274*4882a593Smuzhiyun /* --- */
275*4882a593Smuzhiyun
276*4882a593Smuzhiyun void *private_data;
277*4882a593Smuzhiyun void (*private_free)(struct snd_gus_voice *voice);
278*4882a593Smuzhiyun };
279*4882a593Smuzhiyun
280*4882a593Smuzhiyun struct snd_gf1 {
281*4882a593Smuzhiyun
282*4882a593Smuzhiyun unsigned int enh_mode:1, /* enhanced mode (GFA1) */
283*4882a593Smuzhiyun hw_lfo:1, /* use hardware LFO */
284*4882a593Smuzhiyun sw_lfo:1, /* use software LFO */
285*4882a593Smuzhiyun effect:1; /* use effect voices */
286*4882a593Smuzhiyun
287*4882a593Smuzhiyun unsigned long port; /* port of GF1 chip */
288*4882a593Smuzhiyun struct resource *res_port1;
289*4882a593Smuzhiyun struct resource *res_port2;
290*4882a593Smuzhiyun int irq; /* IRQ number */
291*4882a593Smuzhiyun int dma1; /* DMA1 number */
292*4882a593Smuzhiyun int dma2; /* DMA2 number */
293*4882a593Smuzhiyun unsigned int memory; /* GUS's DRAM size in bytes */
294*4882a593Smuzhiyun unsigned int rom_memory; /* GUS's ROM size in bytes */
295*4882a593Smuzhiyun unsigned int rom_present; /* bitmask */
296*4882a593Smuzhiyun unsigned int rom_banks; /* GUS's ROM banks */
297*4882a593Smuzhiyun
298*4882a593Smuzhiyun struct snd_gf1_mem mem_alloc;
299*4882a593Smuzhiyun
300*4882a593Smuzhiyun /* registers */
301*4882a593Smuzhiyun unsigned short reg_page;
302*4882a593Smuzhiyun unsigned short reg_regsel;
303*4882a593Smuzhiyun unsigned short reg_data8;
304*4882a593Smuzhiyun unsigned short reg_data16;
305*4882a593Smuzhiyun unsigned short reg_irqstat;
306*4882a593Smuzhiyun unsigned short reg_dram;
307*4882a593Smuzhiyun unsigned short reg_timerctrl;
308*4882a593Smuzhiyun unsigned short reg_timerdata;
309*4882a593Smuzhiyun unsigned char ics_regs[6][2];
310*4882a593Smuzhiyun /* --------- */
311*4882a593Smuzhiyun
312*4882a593Smuzhiyun unsigned char active_voices; /* active voices */
313*4882a593Smuzhiyun unsigned char active_voice; /* selected voice (GF1PAGE register) */
314*4882a593Smuzhiyun
315*4882a593Smuzhiyun struct snd_gus_voice voices[32]; /* GF1 voices */
316*4882a593Smuzhiyun
317*4882a593Smuzhiyun unsigned int default_voice_address;
318*4882a593Smuzhiyun
319*4882a593Smuzhiyun unsigned short playback_freq; /* GF1 playback (mixing) frequency */
320*4882a593Smuzhiyun unsigned short mode; /* see to SNDRV_GF1_MODE_XXXX */
321*4882a593Smuzhiyun unsigned char volume_ramp;
322*4882a593Smuzhiyun unsigned char smooth_pan;
323*4882a593Smuzhiyun unsigned char full_range_pan;
324*4882a593Smuzhiyun unsigned char pad0;
325*4882a593Smuzhiyun
326*4882a593Smuzhiyun unsigned char *lfos;
327*4882a593Smuzhiyun
328*4882a593Smuzhiyun /* interrupt handlers */
329*4882a593Smuzhiyun
330*4882a593Smuzhiyun void (*interrupt_handler_midi_out) (struct snd_gus_card * gus);
331*4882a593Smuzhiyun void (*interrupt_handler_midi_in) (struct snd_gus_card * gus);
332*4882a593Smuzhiyun void (*interrupt_handler_timer1) (struct snd_gus_card * gus);
333*4882a593Smuzhiyun void (*interrupt_handler_timer2) (struct snd_gus_card * gus);
334*4882a593Smuzhiyun void (*interrupt_handler_dma_write) (struct snd_gus_card * gus);
335*4882a593Smuzhiyun void (*interrupt_handler_dma_read) (struct snd_gus_card * gus);
336*4882a593Smuzhiyun
337*4882a593Smuzhiyun #ifdef CONFIG_SND_DEBUG
338*4882a593Smuzhiyun unsigned int interrupt_stat_midi_out;
339*4882a593Smuzhiyun unsigned int interrupt_stat_midi_in;
340*4882a593Smuzhiyun unsigned int interrupt_stat_timer1;
341*4882a593Smuzhiyun unsigned int interrupt_stat_timer2;
342*4882a593Smuzhiyun unsigned int interrupt_stat_dma_write;
343*4882a593Smuzhiyun unsigned int interrupt_stat_dma_read;
344*4882a593Smuzhiyun unsigned int interrupt_stat_voice_lost;
345*4882a593Smuzhiyun #endif
346*4882a593Smuzhiyun
347*4882a593Smuzhiyun /* synthesizer */
348*4882a593Smuzhiyun
349*4882a593Smuzhiyun int seq_client;
350*4882a593Smuzhiyun struct snd_gus_port seq_ports[4];
351*4882a593Smuzhiyun
352*4882a593Smuzhiyun /* timer */
353*4882a593Smuzhiyun
354*4882a593Smuzhiyun unsigned short timer_enabled;
355*4882a593Smuzhiyun struct snd_timer *timer1;
356*4882a593Smuzhiyun struct snd_timer *timer2;
357*4882a593Smuzhiyun
358*4882a593Smuzhiyun /* midi */
359*4882a593Smuzhiyun
360*4882a593Smuzhiyun unsigned short uart_cmd;
361*4882a593Smuzhiyun unsigned int uart_framing;
362*4882a593Smuzhiyun unsigned int uart_overrun;
363*4882a593Smuzhiyun
364*4882a593Smuzhiyun /* dma operations */
365*4882a593Smuzhiyun
366*4882a593Smuzhiyun unsigned int dma_flags;
367*4882a593Smuzhiyun unsigned int dma_shared;
368*4882a593Smuzhiyun struct snd_gf1_dma_block *dma_data_pcm;
369*4882a593Smuzhiyun struct snd_gf1_dma_block *dma_data_pcm_last;
370*4882a593Smuzhiyun struct snd_gf1_dma_block *dma_data_synth;
371*4882a593Smuzhiyun struct snd_gf1_dma_block *dma_data_synth_last;
372*4882a593Smuzhiyun void (*dma_ack)(struct snd_gus_card * gus, void *private_data);
373*4882a593Smuzhiyun void *dma_private_data;
374*4882a593Smuzhiyun
375*4882a593Smuzhiyun /* pcm */
376*4882a593Smuzhiyun int pcm_channels;
377*4882a593Smuzhiyun int pcm_alloc_voices;
378*4882a593Smuzhiyun unsigned short pcm_volume_level_left;
379*4882a593Smuzhiyun unsigned short pcm_volume_level_right;
380*4882a593Smuzhiyun unsigned short pcm_volume_level_left1;
381*4882a593Smuzhiyun unsigned short pcm_volume_level_right1;
382*4882a593Smuzhiyun
383*4882a593Smuzhiyun unsigned char pcm_rcntrl_reg;
384*4882a593Smuzhiyun unsigned char pad_end;
385*4882a593Smuzhiyun };
386*4882a593Smuzhiyun
387*4882a593Smuzhiyun /* main structure for GUS card */
388*4882a593Smuzhiyun
389*4882a593Smuzhiyun struct snd_gus_card {
390*4882a593Smuzhiyun struct snd_card *card;
391*4882a593Smuzhiyun
392*4882a593Smuzhiyun unsigned int
393*4882a593Smuzhiyun initialized: 1, /* resources were initialized */
394*4882a593Smuzhiyun equal_irq:1, /* GF1 and CODEC shares IRQ (GUS MAX only) */
395*4882a593Smuzhiyun equal_dma:1, /* if dma channels are equal (not valid for daughter board) */
396*4882a593Smuzhiyun ics_flag:1, /* have we ICS mixer chip */
397*4882a593Smuzhiyun ics_flipped:1, /* ICS mixer have flipped some channels? */
398*4882a593Smuzhiyun codec_flag:1, /* have we CODEC chip? */
399*4882a593Smuzhiyun max_flag:1, /* have we GUS MAX card? */
400*4882a593Smuzhiyun max_ctrl_flag:1, /* have we original GUS MAX card? */
401*4882a593Smuzhiyun daughter_flag:1, /* have we daughter board? */
402*4882a593Smuzhiyun interwave:1, /* hey - we have InterWave card */
403*4882a593Smuzhiyun ess_flag:1, /* ESS chip found... GUS Extreme */
404*4882a593Smuzhiyun ace_flag:1, /* GUS ACE detected */
405*4882a593Smuzhiyun uart_enable:1; /* enable MIDI UART */
406*4882a593Smuzhiyun unsigned short revision; /* revision of chip */
407*4882a593Smuzhiyun unsigned short max_cntrl_val; /* GUS MAX control value */
408*4882a593Smuzhiyun unsigned short mix_cntrl_reg; /* mixer control register */
409*4882a593Smuzhiyun unsigned short joystick_dac; /* joystick DAC level */
410*4882a593Smuzhiyun int timer_dev; /* timer device */
411*4882a593Smuzhiyun
412*4882a593Smuzhiyun struct snd_gf1 gf1; /* gf1 specific variables */
413*4882a593Smuzhiyun struct snd_pcm *pcm;
414*4882a593Smuzhiyun struct snd_pcm_substream *pcm_cap_substream;
415*4882a593Smuzhiyun unsigned int c_dma_size;
416*4882a593Smuzhiyun unsigned int c_period_size;
417*4882a593Smuzhiyun unsigned int c_pos;
418*4882a593Smuzhiyun
419*4882a593Smuzhiyun struct snd_rawmidi *midi_uart;
420*4882a593Smuzhiyun struct snd_rawmidi_substream *midi_substream_output;
421*4882a593Smuzhiyun struct snd_rawmidi_substream *midi_substream_input;
422*4882a593Smuzhiyun
423*4882a593Smuzhiyun spinlock_t reg_lock;
424*4882a593Smuzhiyun spinlock_t voice_alloc;
425*4882a593Smuzhiyun spinlock_t active_voice_lock;
426*4882a593Smuzhiyun spinlock_t event_lock;
427*4882a593Smuzhiyun spinlock_t dma_lock;
428*4882a593Smuzhiyun spinlock_t pcm_volume_level_lock;
429*4882a593Smuzhiyun spinlock_t uart_cmd_lock;
430*4882a593Smuzhiyun struct mutex dma_mutex;
431*4882a593Smuzhiyun struct mutex register_mutex;
432*4882a593Smuzhiyun };
433*4882a593Smuzhiyun
434*4882a593Smuzhiyun /* I/O functions for GF1/InterWave chip - gus_io.c */
435*4882a593Smuzhiyun
snd_gf1_select_voice(struct snd_gus_card * gus,int voice)436*4882a593Smuzhiyun static inline void snd_gf1_select_voice(struct snd_gus_card * gus, int voice)
437*4882a593Smuzhiyun {
438*4882a593Smuzhiyun unsigned long flags;
439*4882a593Smuzhiyun
440*4882a593Smuzhiyun spin_lock_irqsave(&gus->active_voice_lock, flags);
441*4882a593Smuzhiyun if (voice != gus->gf1.active_voice) {
442*4882a593Smuzhiyun gus->gf1.active_voice = voice;
443*4882a593Smuzhiyun outb(voice, GUSP(gus, GF1PAGE));
444*4882a593Smuzhiyun }
445*4882a593Smuzhiyun spin_unlock_irqrestore(&gus->active_voice_lock, flags);
446*4882a593Smuzhiyun }
447*4882a593Smuzhiyun
snd_gf1_uart_cmd(struct snd_gus_card * gus,unsigned char b)448*4882a593Smuzhiyun static inline void snd_gf1_uart_cmd(struct snd_gus_card * gus, unsigned char b)
449*4882a593Smuzhiyun {
450*4882a593Smuzhiyun outb(gus->gf1.uart_cmd = b, GUSP(gus, MIDICTRL));
451*4882a593Smuzhiyun }
452*4882a593Smuzhiyun
snd_gf1_uart_stat(struct snd_gus_card * gus)453*4882a593Smuzhiyun static inline unsigned char snd_gf1_uart_stat(struct snd_gus_card * gus)
454*4882a593Smuzhiyun {
455*4882a593Smuzhiyun return inb(GUSP(gus, MIDISTAT));
456*4882a593Smuzhiyun }
457*4882a593Smuzhiyun
snd_gf1_uart_put(struct snd_gus_card * gus,unsigned char b)458*4882a593Smuzhiyun static inline void snd_gf1_uart_put(struct snd_gus_card * gus, unsigned char b)
459*4882a593Smuzhiyun {
460*4882a593Smuzhiyun outb(b, GUSP(gus, MIDIDATA));
461*4882a593Smuzhiyun }
462*4882a593Smuzhiyun
snd_gf1_uart_get(struct snd_gus_card * gus)463*4882a593Smuzhiyun static inline unsigned char snd_gf1_uart_get(struct snd_gus_card * gus)
464*4882a593Smuzhiyun {
465*4882a593Smuzhiyun return inb(GUSP(gus, MIDIDATA));
466*4882a593Smuzhiyun }
467*4882a593Smuzhiyun
468*4882a593Smuzhiyun extern void snd_gf1_delay(struct snd_gus_card * gus);
469*4882a593Smuzhiyun
470*4882a593Smuzhiyun extern void snd_gf1_ctrl_stop(struct snd_gus_card * gus, unsigned char reg);
471*4882a593Smuzhiyun
472*4882a593Smuzhiyun extern void snd_gf1_write8(struct snd_gus_card * gus, unsigned char reg, unsigned char data);
473*4882a593Smuzhiyun extern unsigned char snd_gf1_look8(struct snd_gus_card * gus, unsigned char reg);
snd_gf1_read8(struct snd_gus_card * gus,unsigned char reg)474*4882a593Smuzhiyun static inline unsigned char snd_gf1_read8(struct snd_gus_card * gus, unsigned char reg)
475*4882a593Smuzhiyun {
476*4882a593Smuzhiyun return snd_gf1_look8(gus, reg | 0x80);
477*4882a593Smuzhiyun }
478*4882a593Smuzhiyun extern void snd_gf1_write16(struct snd_gus_card * gus, unsigned char reg, unsigned int data);
479*4882a593Smuzhiyun extern unsigned short snd_gf1_look16(struct snd_gus_card * gus, unsigned char reg);
snd_gf1_read16(struct snd_gus_card * gus,unsigned char reg)480*4882a593Smuzhiyun static inline unsigned short snd_gf1_read16(struct snd_gus_card * gus, unsigned char reg)
481*4882a593Smuzhiyun {
482*4882a593Smuzhiyun return snd_gf1_look16(gus, reg | 0x80);
483*4882a593Smuzhiyun }
484*4882a593Smuzhiyun extern void snd_gf1_adlib_write(struct snd_gus_card * gus, unsigned char reg, unsigned char data);
485*4882a593Smuzhiyun extern void snd_gf1_dram_addr(struct snd_gus_card * gus, unsigned int addr);
486*4882a593Smuzhiyun extern void snd_gf1_poke(struct snd_gus_card * gus, unsigned int addr, unsigned char data);
487*4882a593Smuzhiyun extern unsigned char snd_gf1_peek(struct snd_gus_card * gus, unsigned int addr);
488*4882a593Smuzhiyun extern void snd_gf1_write_addr(struct snd_gus_card * gus, unsigned char reg, unsigned int addr, short w_16bit);
489*4882a593Smuzhiyun extern unsigned int snd_gf1_read_addr(struct snd_gus_card * gus, unsigned char reg, short w_16bit);
490*4882a593Smuzhiyun extern void snd_gf1_i_ctrl_stop(struct snd_gus_card * gus, unsigned char reg);
491*4882a593Smuzhiyun extern void snd_gf1_i_write8(struct snd_gus_card * gus, unsigned char reg, unsigned char data);
492*4882a593Smuzhiyun extern unsigned char snd_gf1_i_look8(struct snd_gus_card * gus, unsigned char reg);
493*4882a593Smuzhiyun extern void snd_gf1_i_write16(struct snd_gus_card * gus, unsigned char reg, unsigned int data);
snd_gf1_i_read8(struct snd_gus_card * gus,unsigned char reg)494*4882a593Smuzhiyun static inline unsigned char snd_gf1_i_read8(struct snd_gus_card * gus, unsigned char reg)
495*4882a593Smuzhiyun {
496*4882a593Smuzhiyun return snd_gf1_i_look8(gus, reg | 0x80);
497*4882a593Smuzhiyun }
498*4882a593Smuzhiyun extern unsigned short snd_gf1_i_look16(struct snd_gus_card * gus, unsigned char reg);
snd_gf1_i_read16(struct snd_gus_card * gus,unsigned char reg)499*4882a593Smuzhiyun static inline unsigned short snd_gf1_i_read16(struct snd_gus_card * gus, unsigned char reg)
500*4882a593Smuzhiyun {
501*4882a593Smuzhiyun return snd_gf1_i_look16(gus, reg | 0x80);
502*4882a593Smuzhiyun }
503*4882a593Smuzhiyun
504*4882a593Smuzhiyun extern void snd_gf1_select_active_voices(struct snd_gus_card * gus);
505*4882a593Smuzhiyun
506*4882a593Smuzhiyun /* gus_lfo.c */
507*4882a593Smuzhiyun
508*4882a593Smuzhiyun struct _SND_IW_LFO_PROGRAM {
509*4882a593Smuzhiyun unsigned short freq_and_control;
510*4882a593Smuzhiyun unsigned char depth_final;
511*4882a593Smuzhiyun unsigned char depth_inc;
512*4882a593Smuzhiyun unsigned short twave;
513*4882a593Smuzhiyun unsigned short depth;
514*4882a593Smuzhiyun };
515*4882a593Smuzhiyun
516*4882a593Smuzhiyun #if 0
517*4882a593Smuzhiyun extern irqreturn_t snd_gf1_lfo_effect_interrupt(struct snd_gus_card * gus, snd_gf1_voice_t * voice);
518*4882a593Smuzhiyun #endif
519*4882a593Smuzhiyun extern void snd_gf1_lfo_init(struct snd_gus_card * gus);
520*4882a593Smuzhiyun extern void snd_gf1_lfo_done(struct snd_gus_card * gus);
521*4882a593Smuzhiyun extern void snd_gf1_lfo_program(struct snd_gus_card * gus, int voice, int lfo_type, struct _SND_IW_LFO_PROGRAM *program);
522*4882a593Smuzhiyun extern void snd_gf1_lfo_enable(struct snd_gus_card * gus, int voice, int lfo_type);
523*4882a593Smuzhiyun extern void snd_gf1_lfo_disable(struct snd_gus_card * gus, int voice, int lfo_type);
524*4882a593Smuzhiyun extern void snd_gf1_lfo_change_freq(struct snd_gus_card * gus, int voice, int lfo_type, int freq);
525*4882a593Smuzhiyun extern void snd_gf1_lfo_change_depth(struct snd_gus_card * gus, int voice, int lfo_type, int depth);
526*4882a593Smuzhiyun extern void snd_gf1_lfo_setup(struct snd_gus_card * gus, int voice, int lfo_type, int freq, int current_depth, int depth, int sweep, int shape);
527*4882a593Smuzhiyun extern void snd_gf1_lfo_shutdown(struct snd_gus_card * gus, int voice, int lfo_type);
528*4882a593Smuzhiyun #if 0
529*4882a593Smuzhiyun extern void snd_gf1_lfo_command(struct snd_gus_card * gus, int voice, unsigned char *command);
530*4882a593Smuzhiyun #endif
531*4882a593Smuzhiyun
532*4882a593Smuzhiyun /* gus_mem.c */
533*4882a593Smuzhiyun
534*4882a593Smuzhiyun void snd_gf1_mem_lock(struct snd_gf1_mem * alloc, int xup);
535*4882a593Smuzhiyun int snd_gf1_mem_xfree(struct snd_gf1_mem * alloc, struct snd_gf1_mem_block * block);
536*4882a593Smuzhiyun struct snd_gf1_mem_block *snd_gf1_mem_alloc(struct snd_gf1_mem * alloc, int owner,
537*4882a593Smuzhiyun char *name, int size, int w_16,
538*4882a593Smuzhiyun int align, unsigned int *share_id);
539*4882a593Smuzhiyun int snd_gf1_mem_free(struct snd_gf1_mem * alloc, unsigned int address);
540*4882a593Smuzhiyun int snd_gf1_mem_free_owner(struct snd_gf1_mem * alloc, int owner);
541*4882a593Smuzhiyun int snd_gf1_mem_init(struct snd_gus_card * gus);
542*4882a593Smuzhiyun int snd_gf1_mem_done(struct snd_gus_card * gus);
543*4882a593Smuzhiyun
544*4882a593Smuzhiyun /* gus_mem_proc.c */
545*4882a593Smuzhiyun
546*4882a593Smuzhiyun int snd_gf1_mem_proc_init(struct snd_gus_card * gus);
547*4882a593Smuzhiyun
548*4882a593Smuzhiyun /* gus_dma.c */
549*4882a593Smuzhiyun
550*4882a593Smuzhiyun int snd_gf1_dma_init(struct snd_gus_card * gus);
551*4882a593Smuzhiyun int snd_gf1_dma_done(struct snd_gus_card * gus);
552*4882a593Smuzhiyun int snd_gf1_dma_transfer_block(struct snd_gus_card * gus,
553*4882a593Smuzhiyun struct snd_gf1_dma_block * block,
554*4882a593Smuzhiyun int atomic,
555*4882a593Smuzhiyun int synth);
556*4882a593Smuzhiyun
557*4882a593Smuzhiyun /* gus_volume.c */
558*4882a593Smuzhiyun
559*4882a593Smuzhiyun unsigned short snd_gf1_lvol_to_gvol_raw(unsigned int vol);
560*4882a593Smuzhiyun unsigned short snd_gf1_translate_freq(struct snd_gus_card * gus, unsigned int freq2);
561*4882a593Smuzhiyun
562*4882a593Smuzhiyun /* gus_reset.c */
563*4882a593Smuzhiyun
564*4882a593Smuzhiyun void snd_gf1_set_default_handlers(struct snd_gus_card * gus, unsigned int what);
565*4882a593Smuzhiyun void snd_gf1_smart_stop_voice(struct snd_gus_card * gus, unsigned short voice);
566*4882a593Smuzhiyun void snd_gf1_stop_voice(struct snd_gus_card * gus, unsigned short voice);
567*4882a593Smuzhiyun void snd_gf1_stop_voices(struct snd_gus_card * gus, unsigned short v_min, unsigned short v_max);
568*4882a593Smuzhiyun struct snd_gus_voice *snd_gf1_alloc_voice(struct snd_gus_card * gus, int type, int client, int port);
569*4882a593Smuzhiyun void snd_gf1_free_voice(struct snd_gus_card * gus, struct snd_gus_voice *voice);
570*4882a593Smuzhiyun int snd_gf1_start(struct snd_gus_card * gus);
571*4882a593Smuzhiyun int snd_gf1_stop(struct snd_gus_card * gus);
572*4882a593Smuzhiyun
573*4882a593Smuzhiyun /* gus_mixer.c */
574*4882a593Smuzhiyun
575*4882a593Smuzhiyun int snd_gf1_new_mixer(struct snd_gus_card * gus);
576*4882a593Smuzhiyun
577*4882a593Smuzhiyun /* gus_pcm.c */
578*4882a593Smuzhiyun
579*4882a593Smuzhiyun int snd_gf1_pcm_new(struct snd_gus_card *gus, int pcm_dev, int control_index);
580*4882a593Smuzhiyun
581*4882a593Smuzhiyun #ifdef CONFIG_SND_DEBUG
582*4882a593Smuzhiyun extern void snd_gf1_print_voice_registers(struct snd_gus_card * gus);
583*4882a593Smuzhiyun #endif
584*4882a593Smuzhiyun
585*4882a593Smuzhiyun /* gus.c */
586*4882a593Smuzhiyun
587*4882a593Smuzhiyun int snd_gus_use_inc(struct snd_gus_card * gus);
588*4882a593Smuzhiyun void snd_gus_use_dec(struct snd_gus_card * gus);
589*4882a593Smuzhiyun int snd_gus_create(struct snd_card *card,
590*4882a593Smuzhiyun unsigned long port,
591*4882a593Smuzhiyun int irq, int dma1, int dma2,
592*4882a593Smuzhiyun int timer_dev,
593*4882a593Smuzhiyun int voices,
594*4882a593Smuzhiyun int pcm_channels,
595*4882a593Smuzhiyun int effect,
596*4882a593Smuzhiyun struct snd_gus_card ** rgus);
597*4882a593Smuzhiyun int snd_gus_initialize(struct snd_gus_card * gus);
598*4882a593Smuzhiyun
599*4882a593Smuzhiyun /* gus_irq.c */
600*4882a593Smuzhiyun
601*4882a593Smuzhiyun irqreturn_t snd_gus_interrupt(int irq, void *dev_id);
602*4882a593Smuzhiyun #ifdef CONFIG_SND_DEBUG
603*4882a593Smuzhiyun void snd_gus_irq_profile_init(struct snd_gus_card *gus);
604*4882a593Smuzhiyun #endif
605*4882a593Smuzhiyun
606*4882a593Smuzhiyun /* gus_uart.c */
607*4882a593Smuzhiyun
608*4882a593Smuzhiyun int snd_gf1_rawmidi_new(struct snd_gus_card *gus, int device);
609*4882a593Smuzhiyun
610*4882a593Smuzhiyun /* gus_dram.c */
611*4882a593Smuzhiyun int snd_gus_dram_write(struct snd_gus_card *gus, char __user *ptr,
612*4882a593Smuzhiyun unsigned int addr, unsigned int size);
613*4882a593Smuzhiyun int snd_gus_dram_read(struct snd_gus_card *gus, char __user *ptr,
614*4882a593Smuzhiyun unsigned int addr, unsigned int size, int rom);
615*4882a593Smuzhiyun
616*4882a593Smuzhiyun /* gus_timer.c */
617*4882a593Smuzhiyun void snd_gf1_timers_init(struct snd_gus_card *gus);
618*4882a593Smuzhiyun void snd_gf1_timers_done(struct snd_gus_card *gus);
619*4882a593Smuzhiyun
620*4882a593Smuzhiyun #endif /* __SOUND_GUS_H */
621