xref: /linux/include/sound/emu10k1.h (revision de2fe5e07d58424bc286fff3fd3c1b0bf933cd58)
1 #ifndef __SOUND_EMU10K1_H
2 #define __SOUND_EMU10K1_H
3 
4 /*
5  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>,
6  *		     Creative Labs, Inc.
7  *  Definitions for EMU10K1 (SB Live!) chips
8  *
9  *
10  *   This program is free software; you can redistribute it and/or modify
11  *   it under the terms of the GNU General Public License as published by
12  *   the Free Software Foundation; either version 2 of the License, or
13  *   (at your option) any later version.
14  *
15  *   This program is distributed in the hope that it will be useful,
16  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
17  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  *   GNU General Public License for more details.
19  *
20  *   You should have received a copy of the GNU General Public License
21  *   along with this program; if not, write to the Free Software
22  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
23  *
24  */
25 
26 #ifdef __KERNEL__
27 
28 #include <sound/pcm.h>
29 #include <sound/rawmidi.h>
30 #include <sound/hwdep.h>
31 #include <sound/ac97_codec.h>
32 #include <sound/util_mem.h>
33 #include <sound/pcm-indirect.h>
34 #include <sound/timer.h>
35 #include <linux/interrupt.h>
36 #include <linux/mutex.h>
37 #include <asm/io.h>
38 
39 /* ------------------- DEFINES -------------------- */
40 
41 #define EMUPAGESIZE     4096
42 #define MAXREQVOICES    8
43 #define MAXPAGES        8192
44 #define RESERVED        0
45 #define NUM_MIDI        16
46 #define NUM_G           64              /* use all channels */
47 #define NUM_FXSENDS     4
48 #define NUM_EFX_PLAYBACK    16
49 
50 /* FIXME? - according to the OSS driver the EMU10K1 needs a 29 bit DMA mask */
51 #define EMU10K1_DMA_MASK	0x7fffffffUL	/* 31bit */
52 #define AUDIGY_DMA_MASK		0x7fffffffUL	/* 31bit FIXME - 32 should work? */
53 						/* See ALSA bug #1276 - rlrevell */
54 
55 #define TMEMSIZE        256*1024
56 #define TMEMSIZEREG     4
57 
58 #define IP_TO_CP(ip) ((ip == 0) ? 0 : (((0x00001000uL | (ip & 0x00000FFFL)) << (((ip >> 12) & 0x000FL) + 4)) & 0xFFFF0000uL))
59 
60 // Audigy specify registers are prefixed with 'A_'
61 
62 /************************************************************************************************/
63 /* PCI function 0 registers, address = <val> + PCIBASE0						*/
64 /************************************************************************************************/
65 
66 #define PTR			0x00		/* Indexed register set pointer register	*/
67 						/* NOTE: The CHANNELNUM and ADDRESS words can	*/
68 						/* be modified independently of each other.	*/
69 #define PTR_CHANNELNUM_MASK	0x0000003f	/* For each per-channel register, indicates the	*/
70 						/* channel number of the register to be		*/
71 						/* accessed.  For non per-channel registers the	*/
72 						/* value should be set to zero.			*/
73 #define PTR_ADDRESS_MASK	0x07ff0000	/* Register index				*/
74 #define A_PTR_ADDRESS_MASK	0x0fff0000
75 
76 #define DATA			0x04		/* Indexed register set data register		*/
77 
78 #define IPR			0x08		/* Global interrupt pending register		*/
79 						/* Clear pending interrupts by writing a 1 to	*/
80 						/* the relevant bits and zero to the other bits	*/
81 #define IPR_P16V		0x80000000	/* Bit set when the CA0151 P16V chip wishes
82 						   to interrupt */
83 #define IPR_GPIOMSG		0x20000000	/* GPIO message interrupt (RE'd, still not sure
84 						   which INTE bits enable it)			*/
85 
86 /* The next two interrupts are for the midi port on the Audigy Drive (A_MPU1)			*/
87 #define IPR_A_MIDITRANSBUFEMPTY2 0x10000000	/* MIDI UART transmit buffer empty		*/
88 #define IPR_A_MIDIRECVBUFEMPTY2	0x08000000	/* MIDI UART receive buffer empty		*/
89 
90 #define IPR_SPDIFBUFFULL	0x04000000	/* SPDIF capture related, 10k2 only? (RE)	*/
91 #define IPR_SPDIFBUFHALFFULL	0x02000000	/* SPDIF capture related? (RE)			*/
92 
93 #define IPR_SAMPLERATETRACKER	0x01000000	/* Sample rate tracker lock status change	*/
94 #define IPR_FXDSP		0x00800000	/* Enable FX DSP interrupts			*/
95 #define IPR_FORCEINT		0x00400000	/* Force Sound Blaster interrupt		*/
96 #define IPR_PCIERROR		0x00200000	/* PCI bus error				*/
97 #define IPR_VOLINCR		0x00100000	/* Volume increment button pressed		*/
98 #define IPR_VOLDECR		0x00080000	/* Volume decrement button pressed		*/
99 #define IPR_MUTE		0x00040000	/* Mute button pressed				*/
100 #define IPR_MICBUFFULL		0x00020000	/* Microphone buffer full			*/
101 #define IPR_MICBUFHALFFULL	0x00010000	/* Microphone buffer half full			*/
102 #define IPR_ADCBUFFULL		0x00008000	/* ADC buffer full				*/
103 #define IPR_ADCBUFHALFFULL	0x00004000	/* ADC buffer half full				*/
104 #define IPR_EFXBUFFULL		0x00002000	/* Effects buffer full				*/
105 #define IPR_EFXBUFHALFFULL	0x00001000	/* Effects buffer half full			*/
106 #define IPR_GPSPDIFSTATUSCHANGE	0x00000800	/* GPSPDIF channel status change		*/
107 #define IPR_CDROMSTATUSCHANGE	0x00000400	/* CD-ROM channel status change			*/
108 #define IPR_INTERVALTIMER	0x00000200	/* Interval timer terminal count		*/
109 #define IPR_MIDITRANSBUFEMPTY	0x00000100	/* MIDI UART transmit buffer empty		*/
110 #define IPR_MIDIRECVBUFEMPTY	0x00000080	/* MIDI UART receive buffer empty		*/
111 #define IPR_CHANNELLOOP		0x00000040	/* Channel (half) loop interrupt(s) pending	*/
112 #define IPR_CHANNELNUMBERMASK	0x0000003f	/* When IPR_CHANNELLOOP is set, indicates the	*/
113 						/* highest set channel in CLIPL, CLIPH, HLIPL,  */
114 						/* or HLIPH.  When IP is written with CL set,	*/
115 						/* the bit in H/CLIPL or H/CLIPH corresponding	*/
116 						/* to the CIN value written will be cleared.	*/
117 
118 #define INTE			0x0c		/* Interrupt enable register			*/
119 #define INTE_VIRTUALSB_MASK	0xc0000000	/* Virtual Soundblaster I/O port capture	*/
120 #define INTE_VIRTUALSB_220	0x00000000	/* Capture at I/O base address 0x220-0x22f	*/
121 #define INTE_VIRTUALSB_240	0x40000000	/* Capture at I/O base address 0x240		*/
122 #define INTE_VIRTUALSB_260	0x80000000	/* Capture at I/O base address 0x260		*/
123 #define INTE_VIRTUALSB_280	0xc0000000	/* Capture at I/O base address 0x280		*/
124 #define INTE_VIRTUALMPU_MASK	0x30000000	/* Virtual MPU I/O port capture			*/
125 #define INTE_VIRTUALMPU_300	0x00000000	/* Capture at I/O base address 0x300-0x301	*/
126 #define INTE_VIRTUALMPU_310	0x10000000	/* Capture at I/O base address 0x310		*/
127 #define INTE_VIRTUALMPU_320	0x20000000	/* Capture at I/O base address 0x320		*/
128 #define INTE_VIRTUALMPU_330	0x30000000	/* Capture at I/O base address 0x330		*/
129 #define INTE_MASTERDMAENABLE	0x08000000	/* Master DMA emulation at 0x000-0x00f		*/
130 #define INTE_SLAVEDMAENABLE	0x04000000	/* Slave DMA emulation at 0x0c0-0x0df		*/
131 #define INTE_MASTERPICENABLE	0x02000000	/* Master PIC emulation at 0x020-0x021		*/
132 #define INTE_SLAVEPICENABLE	0x01000000	/* Slave PIC emulation at 0x0a0-0x0a1		*/
133 #define INTE_VSBENABLE		0x00800000	/* Enable virtual Soundblaster			*/
134 #define INTE_ADLIBENABLE	0x00400000	/* Enable AdLib emulation at 0x388-0x38b	*/
135 #define INTE_MPUENABLE		0x00200000	/* Enable virtual MPU				*/
136 #define INTE_FORCEINT		0x00100000	/* Continuously assert INTAN			*/
137 
138 #define INTE_MRHANDENABLE	0x00080000	/* Enable the "Mr. Hand" logic			*/
139 						/* NOTE: There is no reason to use this under	*/
140 						/* Linux, and it will cause odd hardware 	*/
141 						/* behavior and possibly random segfaults and	*/
142 						/* lockups if enabled.				*/
143 
144 /* The next two interrupts are for the midi port on the Audigy Drive (A_MPU1)			*/
145 #define INTE_A_MIDITXENABLE2	0x00020000	/* Enable MIDI transmit-buffer-empty interrupts	*/
146 #define INTE_A_MIDIRXENABLE2	0x00010000	/* Enable MIDI receive-buffer-empty interrupts	*/
147 
148 
149 #define INTE_SAMPLERATETRACKER	0x00002000	/* Enable sample rate tracker interrupts	*/
150 						/* NOTE: This bit must always be enabled       	*/
151 #define INTE_FXDSPENABLE	0x00001000	/* Enable FX DSP interrupts			*/
152 #define INTE_PCIERRORENABLE	0x00000800	/* Enable PCI bus error interrupts		*/
153 #define INTE_VOLINCRENABLE	0x00000400	/* Enable volume increment button interrupts	*/
154 #define INTE_VOLDECRENABLE	0x00000200	/* Enable volume decrement button interrupts	*/
155 #define INTE_MUTEENABLE		0x00000100	/* Enable mute button interrupts		*/
156 #define INTE_MICBUFENABLE	0x00000080	/* Enable microphone buffer interrupts		*/
157 #define INTE_ADCBUFENABLE	0x00000040	/* Enable ADC buffer interrupts			*/
158 #define INTE_EFXBUFENABLE	0x00000020	/* Enable Effects buffer interrupts		*/
159 #define INTE_GPSPDIFENABLE	0x00000010	/* Enable GPSPDIF status interrupts		*/
160 #define INTE_CDSPDIFENABLE	0x00000008	/* Enable CDSPDIF status interrupts		*/
161 #define INTE_INTERVALTIMERENB	0x00000004	/* Enable interval timer interrupts		*/
162 #define INTE_MIDITXENABLE	0x00000002	/* Enable MIDI transmit-buffer-empty interrupts	*/
163 #define INTE_MIDIRXENABLE	0x00000001	/* Enable MIDI receive-buffer-empty interrupts	*/
164 
165 #define WC			0x10		/* Wall Clock register				*/
166 #define WC_SAMPLECOUNTER_MASK	0x03FFFFC0	/* Sample periods elapsed since reset		*/
167 #define WC_SAMPLECOUNTER	0x14060010
168 #define WC_CURRENTCHANNEL	0x0000003F	/* Channel [0..63] currently being serviced	*/
169 						/* NOTE: Each channel takes 1/64th of a sample	*/
170 						/* period to be serviced.			*/
171 
172 #define HCFG			0x14		/* Hardware config register			*/
173 						/* NOTE: There is no reason to use the legacy	*/
174 						/* SoundBlaster emulation stuff described below	*/
175 						/* under Linux, and all kinds of weird hardware	*/
176 						/* behavior can result if you try.  Don't.	*/
177 #define HCFG_LEGACYFUNC_MASK	0xe0000000	/* Legacy function number 			*/
178 #define HCFG_LEGACYFUNC_MPU	0x00000000	/* Legacy MPU	 				*/
179 #define HCFG_LEGACYFUNC_SB	0x40000000	/* Legacy SB					*/
180 #define HCFG_LEGACYFUNC_AD	0x60000000	/* Legacy AD					*/
181 #define HCFG_LEGACYFUNC_MPIC	0x80000000	/* Legacy MPIC					*/
182 #define HCFG_LEGACYFUNC_MDMA	0xa0000000	/* Legacy MDMA					*/
183 #define HCFG_LEGACYFUNC_SPCI	0xc0000000	/* Legacy SPCI					*/
184 #define HCFG_LEGACYFUNC_SDMA	0xe0000000	/* Legacy SDMA					*/
185 #define HCFG_IOCAPTUREADDR	0x1f000000	/* The 4 LSBs of the captured I/O address.	*/
186 #define HCFG_LEGACYWRITE	0x00800000	/* 1 = write, 0 = read 				*/
187 #define HCFG_LEGACYWORD		0x00400000	/* 1 = word, 0 = byte 				*/
188 #define HCFG_LEGACYINT		0x00200000	/* 1 = legacy event captured. Write 1 to clear.	*/
189 						/* NOTE: The rest of the bits in this register	*/
190 						/* _are_ relevant under Linux.			*/
191 #define HCFG_CODECFORMAT_MASK	0x00070000	/* CODEC format					*/
192 #define HCFG_CODECFORMAT_AC97	0x00000000	/* AC97 CODEC format -- Primary Output		*/
193 #define HCFG_CODECFORMAT_I2S	0x00010000	/* I2S CODEC format -- Secondary (Rear) Output	*/
194 #define HCFG_GPINPUT0		0x00004000	/* External pin112				*/
195 #define HCFG_GPINPUT1		0x00002000	/* External pin110				*/
196 #define HCFG_GPOUTPUT_MASK	0x00001c00	/* External pins which may be controlled	*/
197 #define HCFG_GPOUT0		0x00001000	/* External pin? (spdif enable on 5.1)		*/
198 #define HCFG_GPOUT1		0x00000800	/* External pin? (IR)				*/
199 #define HCFG_GPOUT2		0x00000400	/* External pin? (IR)				*/
200 #define HCFG_JOYENABLE      	0x00000200	/* Internal joystick enable    			*/
201 #define HCFG_PHASETRACKENABLE	0x00000100	/* Phase tracking enable			*/
202 						/* 1 = Force all 3 async digital inputs to use	*/
203 						/* the same async sample rate tracker (ZVIDEO)	*/
204 #define HCFG_AC3ENABLE_MASK	0x000000e0	/* AC3 async input control - Not implemented	*/
205 #define HCFG_AC3ENABLE_ZVIDEO	0x00000080	/* Channels 0 and 1 replace ZVIDEO		*/
206 #define HCFG_AC3ENABLE_CDSPDIF	0x00000040	/* Channels 0 and 1 replace CDSPDIF		*/
207 #define HCFG_AC3ENABLE_GPSPDIF  0x00000020      /* Channels 0 and 1 replace GPSPDIF             */
208 #define HCFG_AUTOMUTE		0x00000010	/* When set, the async sample rate convertors	*/
209 						/* will automatically mute their output when	*/
210 						/* they are not rate-locked to the external	*/
211 						/* async audio source  				*/
212 #define HCFG_LOCKSOUNDCACHE	0x00000008	/* 1 = Cancel bustmaster accesses to soundcache */
213 						/* NOTE: This should generally never be used.  	*/
214 #define HCFG_LOCKTANKCACHE_MASK	0x00000004	/* 1 = Cancel bustmaster accesses to tankcache	*/
215 						/* NOTE: This should generally never be used.  	*/
216 #define HCFG_LOCKTANKCACHE	0x01020014
217 #define HCFG_MUTEBUTTONENABLE	0x00000002	/* 1 = Master mute button sets AUDIOENABLE = 0.	*/
218 						/* NOTE: This is a 'cheap' way to implement a	*/
219 						/* master mute function on the mute button, and	*/
220 						/* in general should not be used unless a more	*/
221 						/* sophisticated master mute function has not	*/
222 						/* been written.       				*/
223 #define HCFG_AUDIOENABLE	0x00000001	/* 0 = CODECs transmit zero-valued samples	*/
224 						/* Should be set to 1 when the EMU10K1 is	*/
225 						/* completely initialized.			*/
226 
227 //For Audigy, MPU port move to 0x70-0x74 ptr register
228 
229 #define MUDATA			0x18		/* MPU401 data register (8 bits)       		*/
230 
231 #define MUCMD			0x19		/* MPU401 command register (8 bits)    		*/
232 #define MUCMD_RESET		0xff		/* RESET command				*/
233 #define MUCMD_ENTERUARTMODE	0x3f		/* Enter_UART_mode command			*/
234 						/* NOTE: All other commands are ignored		*/
235 
236 #define MUSTAT			MUCMD		/* MPU401 status register (8 bits)     		*/
237 #define MUSTAT_IRDYN		0x80		/* 0 = MIDI data or command ACK			*/
238 #define MUSTAT_ORDYN		0x40		/* 0 = MUDATA can accept a command or data	*/
239 
240 #define A_IOCFG			0x18		/* GPIO on Audigy card (16bits)			*/
241 #define A_GPINPUT_MASK		0xff00
242 #define A_GPOUTPUT_MASK		0x00ff
243 
244 // Audigy output/GPIO stuff taken from the kX drivers
245 #define A_IOCFG_GPOUT0		0x0044		/* analog/digital				*/
246 #define A_IOCFG_DISABLE_ANALOG	0x0040		/* = 'enable' for Audigy2 (chiprev=4)		*/
247 #define A_IOCFG_ENABLE_DIGITAL	0x0004
248 #define A_IOCFG_UNKNOWN_20      0x0020
249 #define A_IOCFG_DISABLE_AC97_FRONT      0x0080  /* turn off ac97 front -> front (10k2.1)	*/
250 #define A_IOCFG_GPOUT1		0x0002		/* IR? drive's internal bypass (?)		*/
251 #define A_IOCFG_GPOUT2		0x0001		/* IR */
252 #define A_IOCFG_MULTIPURPOSE_JACK	0x2000  /* center+lfe+rear_center (a2/a2ex)		*/
253                                                 /* + digital for generic 10k2			*/
254 #define A_IOCFG_DIGITAL_JACK    0x1000          /* digital for a2 platinum			*/
255 #define A_IOCFG_FRONT_JACK      0x4000
256 #define A_IOCFG_REAR_JACK       0x8000
257 #define A_IOCFG_PHONES_JACK     0x0100          /* LiveDrive					*/
258 
259 /* outputs:
260  *	for audigy2 platinum:	0xa00
261  *	for a2 platinum ex:	0x1c00
262  *	for a1 platinum:	0x0
263  */
264 
265 #define TIMER			0x1a		/* Timer terminal count register		*/
266 						/* NOTE: After the rate is changed, a maximum	*/
267 						/* of 1024 sample periods should be allowed	*/
268 						/* before the new rate is guaranteed accurate.	*/
269 #define TIMER_RATE_MASK		0x000003ff	/* Timer interrupt rate in sample periods	*/
270 						/* 0 == 1024 periods, [1..4] are not useful	*/
271 #define TIMER_RATE		0x0a00001a
272 
273 #define AC97DATA		0x1c		/* AC97 register set data register (16 bit)	*/
274 
275 #define AC97ADDRESS		0x1e		/* AC97 register set address register (8 bit)	*/
276 #define AC97ADDRESS_READY	0x80		/* Read-only bit, reflects CODEC READY signal	*/
277 #define AC97ADDRESS_ADDRESS	0x7f		/* Address of indexed AC97 register		*/
278 
279 /* Available on the Audigy 2 and Audigy 4 only. This is the P16V chip. */
280 #define PTR2			0x20		/* Indexed register set pointer register	*/
281 #define DATA2			0x24		/* Indexed register set data register		*/
282 #define IPR2			0x28		/* P16V interrupt pending register		*/
283 #define IPR2_PLAYBACK_CH_0_LOOP      0x00001000 /* Playback Channel 0 loop                               */
284 #define IPR2_PLAYBACK_CH_0_HALF_LOOP 0x00000100 /* Playback Channel 0 half loop                          */
285 #define IPR2_CAPTURE_CH_0_LOOP       0x00100000 /* Capture Channel 0 loop                               */
286 #define IPR2_CAPTURE_CH_0_HALF_LOOP  0x00010000 /* Capture Channel 0 half loop                          */
287 						/* 0x00000100 Playback. Only in once per period.
288 						 * 0x00110000 Capture. Int on half buffer.
289 						 */
290 #define INTE2			0x2c		/* P16V Interrupt enable register. 	*/
291 #define INTE2_PLAYBACK_CH_0_LOOP      0x00001000 /* Playback Channel 0 loop                               */
292 #define INTE2_PLAYBACK_CH_0_HALF_LOOP 0x00000100 /* Playback Channel 0 half loop                          */
293 #define INTE2_PLAYBACK_CH_1_LOOP      0x00002000 /* Playback Channel 1 loop                               */
294 #define INTE2_PLAYBACK_CH_1_HALF_LOOP 0x00000200 /* Playback Channel 1 half loop                          */
295 #define INTE2_PLAYBACK_CH_2_LOOP      0x00004000 /* Playback Channel 2 loop                               */
296 #define INTE2_PLAYBACK_CH_2_HALF_LOOP 0x00000400 /* Playback Channel 2 half loop                          */
297 #define INTE2_PLAYBACK_CH_3_LOOP      0x00008000 /* Playback Channel 3 loop                               */
298 #define INTE2_PLAYBACK_CH_3_HALF_LOOP 0x00000800 /* Playback Channel 3 half loop                          */
299 #define INTE2_CAPTURE_CH_0_LOOP       0x00100000 /* Capture Channel 0 loop                               */
300 #define INTE2_CAPTURE_CH_0_HALF_LOOP  0x00010000 /* Caputre Channel 0 half loop                          */
301 #define HCFG2			0x34		/* Defaults: 0, win2000 sets it to 00004201 */
302 						/* 0x00000000 2-channel output. */
303 						/* 0x00000200 8-channel output. */
304 						/* 0x00000004 pauses stream/irq fail. */
305 						/* Rest of bits no nothing to sound output */
306 						/* bit 0: Enable P16V audio.
307 						 * bit 1: Lock P16V record memory cache.
308 						 * bit 2: Lock P16V playback memory cache.
309 						 * bit 3: Dummy record insert zero samples.
310 						 * bit 8: Record 8-channel in phase.
311 						 * bit 9: Playback 8-channel in phase.
312 						 * bit 11-12: Playback mixer attenuation: 0=0dB, 1=-6dB, 2=-12dB, 3=Mute.
313 						 * bit 13: Playback mixer enable.
314 						 * bit 14: Route SRC48 mixer output to fx engine.
315 						 * bit 15: Enable IEEE 1394 chip.
316 						 */
317 #define IPR3			0x38		/* Cdif interrupt pending register		*/
318 #define INTE3			0x3c		/* Cdif interrupt enable register. 	*/
319 /************************************************************************************************/
320 /* PCI function 1 registers, address = <val> + PCIBASE1						*/
321 /************************************************************************************************/
322 
323 #define JOYSTICK1		0x00		/* Analog joystick port register		*/
324 #define JOYSTICK2		0x01		/* Analog joystick port register		*/
325 #define JOYSTICK3		0x02		/* Analog joystick port register		*/
326 #define JOYSTICK4		0x03		/* Analog joystick port register		*/
327 #define JOYSTICK5		0x04		/* Analog joystick port register		*/
328 #define JOYSTICK6		0x05		/* Analog joystick port register		*/
329 #define JOYSTICK7		0x06		/* Analog joystick port register		*/
330 #define JOYSTICK8		0x07		/* Analog joystick port register		*/
331 
332 /* When writing, any write causes JOYSTICK_COMPARATOR output enable to be pulsed on write.	*/
333 /* When reading, use these bitfields: */
334 #define JOYSTICK_BUTTONS	0x0f		/* Joystick button data				*/
335 #define JOYSTICK_COMPARATOR	0xf0		/* Joystick comparator data			*/
336 
337 
338 /********************************************************************************************************/
339 /* Emu10k1 pointer-offset register set, accessed through the PTR and DATA registers			*/
340 /********************************************************************************************************/
341 
342 #define CPF			0x00		/* Current pitch and fraction register			*/
343 #define CPF_CURRENTPITCH_MASK	0xffff0000	/* Current pitch (linear, 0x4000 == unity pitch shift) 	*/
344 #define CPF_CURRENTPITCH	0x10100000
345 #define CPF_STEREO_MASK		0x00008000	/* 1 = Even channel interleave, odd channel locked	*/
346 #define CPF_STOP_MASK		0x00004000	/* 1 = Current pitch forced to 0			*/
347 #define CPF_FRACADDRESS_MASK	0x00003fff	/* Linear fractional address of the current channel	*/
348 
349 #define PTRX			0x01		/* Pitch target and send A/B amounts register		*/
350 #define PTRX_PITCHTARGET_MASK	0xffff0000	/* Pitch target of specified channel			*/
351 #define PTRX_PITCHTARGET	0x10100001
352 #define PTRX_FXSENDAMOUNT_A_MASK 0x0000ff00	/* Linear level of channel output sent to FX send bus A	*/
353 #define PTRX_FXSENDAMOUNT_A	0x08080001
354 #define PTRX_FXSENDAMOUNT_B_MASK 0x000000ff	/* Linear level of channel output sent to FX send bus B	*/
355 #define PTRX_FXSENDAMOUNT_B	0x08000001
356 
357 #define CVCF			0x02		/* Current volume and filter cutoff register		*/
358 #define CVCF_CURRENTVOL_MASK	0xffff0000	/* Current linear volume of specified channel		*/
359 #define CVCF_CURRENTVOL		0x10100002
360 #define CVCF_CURRENTFILTER_MASK	0x0000ffff	/* Current filter cutoff frequency of specified channel	*/
361 #define CVCF_CURRENTFILTER	0x10000002
362 
363 #define VTFT			0x03		/* Volume target and filter cutoff target register	*/
364 #define VTFT_VOLUMETARGET_MASK	0xffff0000	/* Volume target of specified channel			*/
365 #define VTFT_VOLUMETARGET	0x10100003
366 #define VTFT_FILTERTARGET_MASK	0x0000ffff	/* Filter cutoff target of specified channel		*/
367 #define VTFT_FILTERTARGET	0x10000003
368 
369 #define Z1			0x05		/* Filter delay memory 1 register			*/
370 
371 #define Z2			0x04		/* Filter delay memory 2 register			*/
372 
373 #define PSST			0x06		/* Send C amount and loop start address register	*/
374 #define PSST_FXSENDAMOUNT_C_MASK 0xff000000	/* Linear level of channel output sent to FX send bus C	*/
375 
376 #define PSST_FXSENDAMOUNT_C	0x08180006
377 
378 #define PSST_LOOPSTARTADDR_MASK	0x00ffffff	/* Loop start address of the specified channel		*/
379 #define PSST_LOOPSTARTADDR	0x18000006
380 
381 #define DSL			0x07		/* Send D amount and loop start address register	*/
382 #define DSL_FXSENDAMOUNT_D_MASK	0xff000000	/* Linear level of channel output sent to FX send bus D	*/
383 
384 #define DSL_FXSENDAMOUNT_D	0x08180007
385 
386 #define DSL_LOOPENDADDR_MASK	0x00ffffff	/* Loop end address of the specified channel		*/
387 #define DSL_LOOPENDADDR		0x18000007
388 
389 #define CCCA			0x08		/* Filter Q, interp. ROM, byte size, cur. addr register */
390 #define CCCA_RESONANCE		0xf0000000	/* Lowpass filter resonance (Q) height			*/
391 #define CCCA_INTERPROMMASK	0x0e000000	/* Selects passband of interpolation ROM		*/
392 						/* 1 == full band, 7 == lowpass				*/
393 						/* ROM 0 is used when pitch shifting downward or less	*/
394 						/* then 3 semitones upward.  Increasingly higher ROM	*/
395 						/* numbers are used, typically in steps of 3 semitones,	*/
396 						/* as upward pitch shifting is performed.		*/
397 #define CCCA_INTERPROM_0	0x00000000	/* Select interpolation ROM 0				*/
398 #define CCCA_INTERPROM_1	0x02000000	/* Select interpolation ROM 1				*/
399 #define CCCA_INTERPROM_2	0x04000000	/* Select interpolation ROM 2				*/
400 #define CCCA_INTERPROM_3	0x06000000	/* Select interpolation ROM 3				*/
401 #define CCCA_INTERPROM_4	0x08000000	/* Select interpolation ROM 4				*/
402 #define CCCA_INTERPROM_5	0x0a000000	/* Select interpolation ROM 5				*/
403 #define CCCA_INTERPROM_6	0x0c000000	/* Select interpolation ROM 6				*/
404 #define CCCA_INTERPROM_7	0x0e000000	/* Select interpolation ROM 7				*/
405 #define CCCA_8BITSELECT		0x01000000	/* 1 = Sound memory for this channel uses 8-bit samples	*/
406 #define CCCA_CURRADDR_MASK	0x00ffffff	/* Current address of the selected channel		*/
407 #define CCCA_CURRADDR		0x18000008
408 
409 #define CCR			0x09		/* Cache control register				*/
410 #define CCR_CACHEINVALIDSIZE	0x07190009
411 #define CCR_CACHEINVALIDSIZE_MASK	0xfe000000	/* Number of invalid samples cache for this channel    	*/
412 #define CCR_CACHELOOPFLAG	0x01000000	/* 1 = Cache has a loop service pending			*/
413 #define CCR_INTERLEAVEDSAMPLES	0x00800000	/* 1 = A cache service will fetch interleaved samples	*/
414 #define CCR_WORDSIZEDSAMPLES	0x00400000	/* 1 = A cache service will fetch word sized samples	*/
415 #define CCR_READADDRESS		0x06100009
416 #define CCR_READADDRESS_MASK	0x003f0000	/* Location of cache just beyond current cache service	*/
417 #define CCR_LOOPINVALSIZE	0x0000fe00	/* Number of invalid samples in cache prior to loop	*/
418 						/* NOTE: This is valid only if CACHELOOPFLAG is set	*/
419 #define CCR_LOOPFLAG		0x00000100	/* Set for a single sample period when a loop occurs	*/
420 #define CCR_CACHELOOPADDRHI	0x000000ff	/* DSL_LOOPSTARTADDR's hi byte if CACHELOOPFLAG is set	*/
421 
422 #define CLP			0x0a		/* Cache loop register (valid if CCR_CACHELOOPFLAG = 1) */
423 						/* NOTE: This register is normally not used		*/
424 #define CLP_CACHELOOPADDR	0x0000ffff	/* Cache loop address (DSL_LOOPSTARTADDR [0..15])	*/
425 
426 #define FXRT			0x0b		/* Effects send routing register			*/
427 						/* NOTE: It is illegal to assign the same routing to	*/
428 						/* two effects sends.					*/
429 #define FXRT_CHANNELA		0x000f0000	/* Effects send bus number for channel's effects send A	*/
430 #define FXRT_CHANNELB		0x00f00000	/* Effects send bus number for channel's effects send B	*/
431 #define FXRT_CHANNELC		0x0f000000	/* Effects send bus number for channel's effects send C	*/
432 #define FXRT_CHANNELD		0xf0000000	/* Effects send bus number for channel's effects send D	*/
433 
434 #define MAPA			0x0c		/* Cache map A						*/
435 
436 #define MAPB			0x0d		/* Cache map B						*/
437 
438 #define MAP_PTE_MASK		0xffffe000	/* The 19 MSBs of the PTE indexed by the PTI		*/
439 #define MAP_PTI_MASK		0x00001fff	/* The 13 bit index to one of the 8192 PTE dwords      	*/
440 
441 #define ENVVOL			0x10		/* Volume envelope register				*/
442 #define ENVVOL_MASK		0x0000ffff	/* Current value of volume envelope state variable	*/
443 						/* 0x8000-n == 666*n usec delay	       			*/
444 
445 #define ATKHLDV 		0x11		/* Volume envelope hold and attack register		*/
446 #define ATKHLDV_PHASE0		0x00008000	/* 0 = Begin attack phase				*/
447 #define ATKHLDV_HOLDTIME_MASK	0x00007f00	/* Envelope hold time (127-n == n*88.2msec)		*/
448 #define ATKHLDV_ATTACKTIME_MASK	0x0000007f	/* Envelope attack time, log encoded			*/
449 						/* 0 = infinite, 1 = 10.9msec, ... 0x7f = 5.5msec	*/
450 
451 #define DCYSUSV 		0x12		/* Volume envelope sustain and decay register		*/
452 #define DCYSUSV_PHASE1_MASK	0x00008000	/* 0 = Begin attack phase, 1 = begin release phase	*/
453 #define DCYSUSV_SUSTAINLEVEL_MASK 0x00007f00	/* 127 = full, 0 = off, 0.75dB increments		*/
454 #define DCYSUSV_CHANNELENABLE_MASK 0x00000080	/* 1 = Inhibit envelope engine from writing values in	*/
455 						/* this channel and from writing to pitch, filter and	*/
456 						/* volume targets.					*/
457 #define DCYSUSV_DECAYTIME_MASK	0x0000007f	/* Volume envelope decay time, log encoded     		*/
458 						/* 0 = 43.7msec, 1 = 21.8msec, 0x7f = 22msec		*/
459 
460 #define LFOVAL1 		0x13		/* Modulation LFO value					*/
461 #define LFOVAL_MASK		0x0000ffff	/* Current value of modulation LFO state variable	*/
462 						/* 0x8000-n == 666*n usec delay				*/
463 
464 #define ENVVAL			0x14		/* Modulation envelope register				*/
465 #define ENVVAL_MASK		0x0000ffff	/* Current value of modulation envelope state variable 	*/
466 						/* 0x8000-n == 666*n usec delay				*/
467 
468 #define ATKHLDM			0x15		/* Modulation envelope hold and attack register		*/
469 #define ATKHLDM_PHASE0		0x00008000	/* 0 = Begin attack phase				*/
470 #define ATKHLDM_HOLDTIME	0x00007f00	/* Envelope hold time (127-n == n*42msec)		*/
471 #define ATKHLDM_ATTACKTIME	0x0000007f	/* Envelope attack time, log encoded			*/
472 						/* 0 = infinite, 1 = 11msec, ... 0x7f = 5.5msec		*/
473 
474 #define DCYSUSM			0x16		/* Modulation envelope decay and sustain register	*/
475 #define DCYSUSM_PHASE1_MASK	0x00008000	/* 0 = Begin attack phase, 1 = begin release phase	*/
476 #define DCYSUSM_SUSTAINLEVEL_MASK 0x00007f00	/* 127 = full, 0 = off, 0.75dB increments		*/
477 #define DCYSUSM_DECAYTIME_MASK	0x0000007f	/* Envelope decay time, log encoded			*/
478 						/* 0 = 43.7msec, 1 = 21.8msec, 0x7f = 22msec		*/
479 
480 #define LFOVAL2 		0x17		/* Vibrato LFO register					*/
481 #define LFOVAL2_MASK		0x0000ffff	/* Current value of vibrato LFO state variable 		*/
482 						/* 0x8000-n == 666*n usec delay				*/
483 
484 #define IP			0x18		/* Initial pitch register				*/
485 #define IP_MASK			0x0000ffff	/* Exponential initial pitch shift			*/
486 						/* 4 bits of octave, 12 bits of fractional octave	*/
487 #define IP_UNITY		0x0000e000	/* Unity pitch shift					*/
488 
489 #define IFATN			0x19		/* Initial filter cutoff and attenuation register	*/
490 #define IFATN_FILTERCUTOFF_MASK	0x0000ff00	/* Initial filter cutoff frequency in exponential units	*/
491 						/* 6 most significant bits are semitones		*/
492 						/* 2 least significant bits are fractions		*/
493 #define IFATN_FILTERCUTOFF	0x08080019
494 #define IFATN_ATTENUATION_MASK	0x000000ff	/* Initial attenuation in 0.375dB steps			*/
495 #define IFATN_ATTENUATION	0x08000019
496 
497 
498 #define PEFE			0x1a		/* Pitch envelope and filter envelope amount register	*/
499 #define PEFE_PITCHAMOUNT_MASK	0x0000ff00	/* Pitch envlope amount					*/
500 						/* Signed 2's complement, +/- one octave peak extremes	*/
501 #define PEFE_PITCHAMOUNT	0x0808001a
502 #define PEFE_FILTERAMOUNT_MASK	0x000000ff	/* Filter envlope amount				*/
503 						/* Signed 2's complement, +/- six octaves peak extremes */
504 #define PEFE_FILTERAMOUNT	0x0800001a
505 #define FMMOD			0x1b		/* Vibrato/filter modulation from LFO register		*/
506 #define FMMOD_MODVIBRATO	0x0000ff00	/* Vibrato LFO modulation depth				*/
507 						/* Signed 2's complement, +/- one octave extremes	*/
508 #define FMMOD_MOFILTER		0x000000ff	/* Filter LFO modulation depth				*/
509 						/* Signed 2's complement, +/- three octave extremes	*/
510 
511 
512 #define TREMFRQ 		0x1c		/* Tremolo amount and modulation LFO frequency register	*/
513 #define TREMFRQ_DEPTH		0x0000ff00	/* Tremolo depth					*/
514 						/* Signed 2's complement, with +/- 12dB extremes	*/
515 
516 #define TREMFRQ_FREQUENCY	0x000000ff	/* Tremolo LFO frequency				*/
517 						/* ??Hz steps, maximum of ?? Hz.			*/
518 #define FM2FRQ2 		0x1d		/* Vibrato amount and vibrato LFO frequency register	*/
519 #define FM2FRQ2_DEPTH		0x0000ff00	/* Vibrato LFO vibrato depth				*/
520 						/* Signed 2's complement, +/- one octave extremes	*/
521 #define FM2FRQ2_FREQUENCY	0x000000ff	/* Vibrato LFO frequency				*/
522 						/* 0.039Hz steps, maximum of 9.85 Hz.			*/
523 
524 #define TEMPENV 		0x1e		/* Tempory envelope register				*/
525 #define TEMPENV_MASK		0x0000ffff	/* 16-bit value						*/
526 						/* NOTE: All channels contain internal variables; do	*/
527 						/* not write to these locations.			*/
528 
529 /* 1f something */
530 
531 #define CD0			0x20		/* Cache data 0 register				*/
532 #define CD1			0x21		/* Cache data 1 register				*/
533 #define CD2			0x22		/* Cache data 2 register				*/
534 #define CD3			0x23		/* Cache data 3 register				*/
535 #define CD4			0x24		/* Cache data 4 register				*/
536 #define CD5			0x25		/* Cache data 5 register				*/
537 #define CD6			0x26		/* Cache data 6 register				*/
538 #define CD7			0x27		/* Cache data 7 register				*/
539 #define CD8			0x28		/* Cache data 8 register				*/
540 #define CD9			0x29		/* Cache data 9 register				*/
541 #define CDA			0x2a		/* Cache data A register				*/
542 #define CDB			0x2b		/* Cache data B register				*/
543 #define CDC			0x2c		/* Cache data C register				*/
544 #define CDD			0x2d		/* Cache data D register				*/
545 #define CDE			0x2e		/* Cache data E register				*/
546 #define CDF			0x2f		/* Cache data F register				*/
547 
548 /* 0x30-3f seem to be the same as 0x20-2f */
549 
550 #define PTB			0x40		/* Page table base register				*/
551 #define PTB_MASK		0xfffff000	/* Physical address of the page table in host memory	*/
552 
553 #define TCB			0x41		/* Tank cache base register    				*/
554 #define TCB_MASK		0xfffff000	/* Physical address of the bottom of host based TRAM	*/
555 
556 #define ADCCR			0x42		/* ADC sample rate/stereo control register		*/
557 #define ADCCR_RCHANENABLE	0x00000010	/* Enables right channel for writing to the host       	*/
558 #define ADCCR_LCHANENABLE	0x00000008	/* Enables left channel for writing to the host		*/
559 						/* NOTE: To guarantee phase coherency, both channels	*/
560 						/* must be disabled prior to enabling both channels.	*/
561 #define A_ADCCR_RCHANENABLE	0x00000020
562 #define A_ADCCR_LCHANENABLE	0x00000010
563 
564 #define A_ADCCR_SAMPLERATE_MASK 0x0000000F      /* Audigy sample rate convertor output rate		*/
565 #define ADCCR_SAMPLERATE_MASK	0x00000007	/* Sample rate convertor output rate			*/
566 #define ADCCR_SAMPLERATE_48	0x00000000	/* 48kHz sample rate					*/
567 #define ADCCR_SAMPLERATE_44	0x00000001	/* 44.1kHz sample rate					*/
568 #define ADCCR_SAMPLERATE_32	0x00000002	/* 32kHz sample rate					*/
569 #define ADCCR_SAMPLERATE_24	0x00000003	/* 24kHz sample rate					*/
570 #define ADCCR_SAMPLERATE_22	0x00000004	/* 22.05kHz sample rate					*/
571 #define ADCCR_SAMPLERATE_16	0x00000005	/* 16kHz sample rate					*/
572 #define ADCCR_SAMPLERATE_11	0x00000006	/* 11.025kHz sample rate				*/
573 #define ADCCR_SAMPLERATE_8	0x00000007	/* 8kHz sample rate					*/
574 #define A_ADCCR_SAMPLERATE_12	0x00000006	/* 12kHz sample rate					*/
575 #define A_ADCCR_SAMPLERATE_11	0x00000007	/* 11.025kHz sample rate				*/
576 #define A_ADCCR_SAMPLERATE_8	0x00000008	/* 8kHz sample rate					*/
577 
578 #define FXWC			0x43		/* FX output write channels register			*/
579 						/* When set, each bit enables the writing of the	*/
580 						/* corresponding FX output channel (internal registers  */
581 						/* 0x20-0x3f) to host memory.  This mode of recording   */
582 						/* is 16bit, 48KHz only. All 32 channels can be enabled */
583 						/* simultaneously.					*/
584 
585 #define FXWC_DEFAULTROUTE_C     (1<<0)		/* left emu out? */
586 #define FXWC_DEFAULTROUTE_B     (1<<1)		/* right emu out? */
587 #define FXWC_DEFAULTROUTE_A     (1<<12)
588 #define FXWC_DEFAULTROUTE_D     (1<<13)
589 #define FXWC_ADCLEFT            (1<<18)
590 #define FXWC_CDROMSPDIFLEFT     (1<<18)
591 #define FXWC_ADCRIGHT           (1<<19)
592 #define FXWC_CDROMSPDIFRIGHT    (1<<19)
593 #define FXWC_MIC                (1<<20)
594 #define FXWC_ZOOMLEFT           (1<<20)
595 #define FXWC_ZOOMRIGHT          (1<<21)
596 #define FXWC_SPDIFLEFT          (1<<22)		/* 0x00400000 */
597 #define FXWC_SPDIFRIGHT         (1<<23)		/* 0x00800000 */
598 
599 #define TCBS			0x44		/* Tank cache buffer size register			*/
600 #define TCBS_MASK		0x00000007	/* Tank cache buffer size field				*/
601 #define TCBS_BUFFSIZE_16K	0x00000000
602 #define TCBS_BUFFSIZE_32K	0x00000001
603 #define TCBS_BUFFSIZE_64K	0x00000002
604 #define TCBS_BUFFSIZE_128K	0x00000003
605 #define TCBS_BUFFSIZE_256K	0x00000004
606 #define TCBS_BUFFSIZE_512K	0x00000005
607 #define TCBS_BUFFSIZE_1024K	0x00000006
608 #define TCBS_BUFFSIZE_2048K	0x00000007
609 
610 #define MICBA			0x45		/* AC97 microphone buffer address register		*/
611 #define MICBA_MASK		0xfffff000	/* 20 bit base address					*/
612 
613 #define ADCBA			0x46		/* ADC buffer address register				*/
614 #define ADCBA_MASK		0xfffff000	/* 20 bit base address					*/
615 
616 #define FXBA			0x47		/* FX Buffer Address */
617 #define FXBA_MASK		0xfffff000	/* 20 bit base address					*/
618 
619 /* 0x48 something - word access, defaults to 3f */
620 
621 #define MICBS			0x49		/* Microphone buffer size register			*/
622 
623 #define ADCBS			0x4a		/* ADC buffer size register				*/
624 
625 #define FXBS			0x4b		/* FX buffer size register				*/
626 
627 /* register: 0x4c..4f: ffff-ffff current amounts, per-channel */
628 
629 /* The following mask values define the size of the ADC, MIX and FX buffers in bytes */
630 #define ADCBS_BUFSIZE_NONE	0x00000000
631 #define ADCBS_BUFSIZE_384	0x00000001
632 #define ADCBS_BUFSIZE_448	0x00000002
633 #define ADCBS_BUFSIZE_512	0x00000003
634 #define ADCBS_BUFSIZE_640	0x00000004
635 #define ADCBS_BUFSIZE_768	0x00000005
636 #define ADCBS_BUFSIZE_896	0x00000006
637 #define ADCBS_BUFSIZE_1024	0x00000007
638 #define ADCBS_BUFSIZE_1280	0x00000008
639 #define ADCBS_BUFSIZE_1536	0x00000009
640 #define ADCBS_BUFSIZE_1792	0x0000000a
641 #define ADCBS_BUFSIZE_2048	0x0000000b
642 #define ADCBS_BUFSIZE_2560	0x0000000c
643 #define ADCBS_BUFSIZE_3072	0x0000000d
644 #define ADCBS_BUFSIZE_3584	0x0000000e
645 #define ADCBS_BUFSIZE_4096	0x0000000f
646 #define ADCBS_BUFSIZE_5120	0x00000010
647 #define ADCBS_BUFSIZE_6144	0x00000011
648 #define ADCBS_BUFSIZE_7168	0x00000012
649 #define ADCBS_BUFSIZE_8192	0x00000013
650 #define ADCBS_BUFSIZE_10240	0x00000014
651 #define ADCBS_BUFSIZE_12288	0x00000015
652 #define ADCBS_BUFSIZE_14366	0x00000016
653 #define ADCBS_BUFSIZE_16384	0x00000017
654 #define ADCBS_BUFSIZE_20480	0x00000018
655 #define ADCBS_BUFSIZE_24576	0x00000019
656 #define ADCBS_BUFSIZE_28672	0x0000001a
657 #define ADCBS_BUFSIZE_32768	0x0000001b
658 #define ADCBS_BUFSIZE_40960	0x0000001c
659 #define ADCBS_BUFSIZE_49152	0x0000001d
660 #define ADCBS_BUFSIZE_57344	0x0000001e
661 #define ADCBS_BUFSIZE_65536	0x0000001f
662 
663 
664 #define CDCS			0x50		/* CD-ROM digital channel status register	*/
665 
666 #define GPSCS			0x51		/* General Purpose SPDIF channel status register*/
667 
668 #define DBG			0x52		/* DO NOT PROGRAM THIS REGISTER!!! MAY DESTROY CHIP */
669 
670 #define REG53			0x53		/* DO NOT PROGRAM THIS REGISTER!!! MAY DESTROY CHIP */
671 
672 #define A_DBG			 0x53
673 #define A_DBG_SINGLE_STEP	 0x00020000	/* Set to zero to start dsp */
674 #define A_DBG_ZC		 0x40000000	/* zero tram counter */
675 #define A_DBG_STEP_ADDR		 0x000003ff
676 #define A_DBG_SATURATION_OCCURED 0x20000000
677 #define A_DBG_SATURATION_ADDR	 0x0ffc0000
678 
679 // NOTE: 0x54,55,56: 64-bit
680 #define SPCS0			0x54		/* SPDIF output Channel Status 0 register	*/
681 
682 #define SPCS1			0x55		/* SPDIF output Channel Status 1 register	*/
683 
684 #define SPCS2			0x56		/* SPDIF output Channel Status 2 register	*/
685 
686 #define SPCS_CLKACCYMASK	0x30000000	/* Clock accuracy				*/
687 #define SPCS_CLKACCY_1000PPM	0x00000000	/* 1000 parts per million			*/
688 #define SPCS_CLKACCY_50PPM	0x10000000	/* 50 parts per million				*/
689 #define SPCS_CLKACCY_VARIABLE	0x20000000	/* Variable accuracy				*/
690 #define SPCS_SAMPLERATEMASK	0x0f000000	/* Sample rate					*/
691 #define SPCS_SAMPLERATE_44	0x00000000	/* 44.1kHz sample rate				*/
692 #define SPCS_SAMPLERATE_48	0x02000000	/* 48kHz sample rate				*/
693 #define SPCS_SAMPLERATE_32	0x03000000	/* 32kHz sample rate				*/
694 #define SPCS_CHANNELNUMMASK	0x00f00000	/* Channel number				*/
695 #define SPCS_CHANNELNUM_UNSPEC	0x00000000	/* Unspecified channel number			*/
696 #define SPCS_CHANNELNUM_LEFT	0x00100000	/* Left channel					*/
697 #define SPCS_CHANNELNUM_RIGHT	0x00200000	/* Right channel				*/
698 #define SPCS_SOURCENUMMASK	0x000f0000	/* Source number				*/
699 #define SPCS_SOURCENUM_UNSPEC	0x00000000	/* Unspecified source number			*/
700 #define SPCS_GENERATIONSTATUS	0x00008000	/* Originality flag (see IEC-958 spec)		*/
701 #define SPCS_CATEGORYCODEMASK	0x00007f00	/* Category code (see IEC-958 spec)		*/
702 #define SPCS_MODEMASK		0x000000c0	/* Mode (see IEC-958 spec)			*/
703 #define SPCS_EMPHASISMASK	0x00000038	/* Emphasis					*/
704 #define SPCS_EMPHASIS_NONE	0x00000000	/* No emphasis					*/
705 #define SPCS_EMPHASIS_50_15	0x00000008	/* 50/15 usec 2 channel				*/
706 #define SPCS_COPYRIGHT		0x00000004	/* Copyright asserted flag -- do not modify	*/
707 #define SPCS_NOTAUDIODATA	0x00000002	/* 0 = Digital audio, 1 = not audio		*/
708 #define SPCS_PROFESSIONAL	0x00000001	/* 0 = Consumer (IEC-958), 1 = pro (AES3-1992)	*/
709 
710 /* The 32-bit CLIx and SOLx registers all have one bit per channel control/status      		*/
711 #define CLIEL			0x58		/* Channel loop interrupt enable low register	*/
712 
713 #define CLIEH			0x59		/* Channel loop interrupt enable high register	*/
714 
715 #define CLIPL			0x5a		/* Channel loop interrupt pending low register	*/
716 
717 #define CLIPH			0x5b		/* Channel loop interrupt pending high register	*/
718 
719 #define SOLEL			0x5c		/* Stop on loop enable low register		*/
720 
721 #define SOLEH			0x5d		/* Stop on loop enable high register		*/
722 
723 #define SPBYPASS		0x5e		/* SPDIF BYPASS mode register			*/
724 #define SPBYPASS_SPDIF0_MASK	0x00000003	/* SPDIF 0 bypass mode				*/
725 #define SPBYPASS_SPDIF1_MASK	0x0000000c	/* SPDIF 1 bypass mode				*/
726 /* bypass mode: 0 - DSP; 1 - SPDIF A, 2 - SPDIF B, 3 - SPDIF C					*/
727 #define SPBYPASS_FORMAT		0x00000f00      /* If 1, SPDIF XX uses 24 bit, if 0 - 20 bit	*/
728 
729 #define AC97SLOT		0x5f            /* additional AC97 slots enable bits		*/
730 #define AC97SLOT_REAR_RIGHT	0x01		/* Rear left */
731 #define AC97SLOT_REAR_LEFT	0x02		/* Rear right */
732 #define AC97SLOT_CNTR		0x10            /* Center enable */
733 #define AC97SLOT_LFE		0x20            /* LFE enable */
734 
735 // NOTE: 0x60,61,62: 64-bit
736 #define CDSRCS			0x60		/* CD-ROM Sample Rate Converter status register	*/
737 
738 #define GPSRCS			0x61		/* General Purpose SPDIF sample rate cvt status */
739 
740 #define ZVSRCS			0x62		/* ZVideo sample rate converter status		*/
741 						/* NOTE: This one has no SPDIFLOCKED field	*/
742 						/* Assumes sample lock				*/
743 
744 /* These three bitfields apply to CDSRCS, GPSRCS, and (except as noted) ZVSRCS.			*/
745 #define SRCS_SPDIFVALID		0x04000000	/* SPDIF stream valid				*/
746 #define SRCS_SPDIFLOCKED	0x02000000	/* SPDIF stream locked				*/
747 #define SRCS_RATELOCKED		0x01000000	/* Sample rate locked				*/
748 #define SRCS_ESTSAMPLERATE	0x0007ffff	/* Do not modify this field.			*/
749 
750 /* Note that these values can vary +/- by a small amount                                        */
751 #define SRCS_SPDIFRATE_44	0x0003acd9
752 #define SRCS_SPDIFRATE_48	0x00040000
753 #define SRCS_SPDIFRATE_96	0x00080000
754 
755 #define MICIDX                  0x63            /* Microphone recording buffer index register   */
756 #define MICIDX_MASK             0x0000ffff      /* 16-bit value                                 */
757 #define MICIDX_IDX		0x10000063
758 
759 #define ADCIDX			0x64		/* ADC recording buffer index register		*/
760 #define ADCIDX_MASK		0x0000ffff	/* 16 bit index field				*/
761 #define ADCIDX_IDX		0x10000064
762 
763 #define A_ADCIDX		0x63
764 #define A_ADCIDX_IDX		0x10000063
765 
766 #define A_MICIDX		0x64
767 #define A_MICIDX_IDX		0x10000064
768 
769 #define FXIDX			0x65		/* FX recording buffer index register		*/
770 #define FXIDX_MASK		0x0000ffff	/* 16-bit value					*/
771 #define FXIDX_IDX		0x10000065
772 
773 /* The 32-bit HLIx and HLIPx registers all have one bit per channel control/status      		*/
774 #define HLIEL			0x66		/* Channel half loop interrupt enable low register	*/
775 
776 #define HLIEH			0x67		/* Channel half loop interrupt enable high register	*/
777 
778 #define HLIPL			0x68		/* Channel half loop interrupt pending low register	*/
779 
780 #define HLIPH			0x69		/* Channel half loop interrupt pending high register	*/
781 
782 // 0x6a,6b,6c used for some recording
783 // 0x6d unused
784 // 0x6e,6f - tanktable base / offset
785 
786 /* This is the MPU port on the card (via the game port)						*/
787 #define A_MUDATA1		0x70
788 #define A_MUCMD1		0x71
789 #define A_MUSTAT1		A_MUCMD1
790 
791 /* This is the MPU port on the Audigy Drive 							*/
792 #define A_MUDATA2		0x72
793 #define A_MUCMD2		0x73
794 #define A_MUSTAT2		A_MUCMD2
795 
796 /* The next two are the Audigy equivalent of FXWC						*/
797 /* the Audigy can record any output (16bit, 48kHz, up to 64 channel simultaneously) 		*/
798 /* Each bit selects a channel for recording */
799 #define A_FXWC1			0x74            /* Selects 0x7f-0x60 for FX recording           */
800 #define A_FXWC2			0x75		/* Selects 0x9f-0x80 for FX recording           */
801 
802 #define A_SPDIF_SAMPLERATE	0x76		/* Set the sample rate of SPDIF output		*/
803 #define A_SAMPLE_RATE		0x76		/* Various sample rate settings. */
804 #define A_SAMPLE_RATE_NOT_USED  0x0ffc111e	/* Bits that are not used and cannot be set. 	*/
805 #define A_SAMPLE_RATE_UNKNOWN	0xf0030001	/* Bits that can be set, but have unknown use. 	*/
806 #define A_SPDIF_RATE_MASK	0x000000e0	/* Any other values for rates, just use 48000	*/
807 #define A_SPDIF_48000		0x00000000
808 #define A_SPDIF_192000		0x00000020
809 #define A_SPDIF_96000		0x00000040
810 #define A_SPDIF_44100		0x00000080
811 
812 #define A_I2S_CAPTURE_RATE_MASK	0x00000e00	/* This sets the capture PCM rate, but it is    */
813 #define A_I2S_CAPTURE_48000	0x00000000	/* unclear if this sets the ADC rate as well.	*/
814 #define A_I2S_CAPTURE_192000	0x00000200
815 #define A_I2S_CAPTURE_96000	0x00000400
816 #define A_I2S_CAPTURE_44100	0x00000800
817 
818 #define A_PCM_RATE_MASK		0x0000e000	/* This sets the playback PCM rate on the P16V	*/
819 #define A_PCM_48000		0x00000000
820 #define A_PCM_192000		0x00002000
821 #define A_PCM_96000		0x00004000
822 #define A_PCM_44100		0x00008000
823 
824 /* 0x77,0x78,0x79 "something i2s-related" - default to 0x01080000 on my audigy 2 ZS --rlrevell	*/
825 /* 0x7a, 0x7b - lookup tables */
826 
827 #define A_FXRT2			0x7c
828 #define A_FXRT_CHANNELE		0x0000003f	/* Effects send bus number for channel's effects send E	*/
829 #define A_FXRT_CHANNELF		0x00003f00	/* Effects send bus number for channel's effects send F	*/
830 #define A_FXRT_CHANNELG		0x003f0000	/* Effects send bus number for channel's effects send G	*/
831 #define A_FXRT_CHANNELH		0x3f000000	/* Effects send bus number for channel's effects send H	*/
832 
833 #define A_SENDAMOUNTS		0x7d
834 #define A_FXSENDAMOUNT_E_MASK	0xFF000000
835 #define A_FXSENDAMOUNT_F_MASK	0x00FF0000
836 #define A_FXSENDAMOUNT_G_MASK	0x0000FF00
837 #define A_FXSENDAMOUNT_H_MASK	0x000000FF
838 /* 0x7c, 0x7e "high bit is used for filtering" */
839 
840 /* The send amounts for this one are the same as used with the emu10k1 */
841 #define A_FXRT1			0x7e
842 #define A_FXRT_CHANNELA		0x0000003f
843 #define A_FXRT_CHANNELB		0x00003f00
844 #define A_FXRT_CHANNELC		0x003f0000
845 #define A_FXRT_CHANNELD		0x3f000000
846 
847 
848 /* Each FX general purpose register is 32 bits in length, all bits are used			*/
849 #define FXGPREGBASE		0x100		/* FX general purpose registers base       	*/
850 #define A_FXGPREGBASE		0x400		/* Audigy GPRs, 0x400 to 0x5ff			*/
851 
852 #define A_TANKMEMCTLREGBASE	0x100		/* Tank memory control registers base - only for Audigy */
853 #define A_TANKMEMCTLREG_MASK	0x1f		/* only 5 bits used - only for Audigy */
854 
855 /* Tank audio data is logarithmically compressed down to 16 bits before writing to TRAM and is	*/
856 /* decompressed back to 20 bits on a read.  There are a total of 160 locations, the last 32	*/
857 /* locations are for external TRAM. 								*/
858 #define TANKMEMDATAREGBASE	0x200		/* Tank memory data registers base     		*/
859 #define TANKMEMDATAREG_MASK	0x000fffff	/* 20 bit tank audio data field			*/
860 
861 /* Combined address field and memory opcode or flag field.  160 locations, last 32 are external	*/
862 #define TANKMEMADDRREGBASE	0x300		/* Tank memory address registers base		*/
863 #define TANKMEMADDRREG_ADDR_MASK 0x000fffff	/* 20 bit tank address field			*/
864 #define TANKMEMADDRREG_CLEAR	0x00800000	/* Clear tank memory				*/
865 #define TANKMEMADDRREG_ALIGN	0x00400000	/* Align read or write relative to tank access	*/
866 #define TANKMEMADDRREG_WRITE	0x00200000	/* Write to tank memory				*/
867 #define TANKMEMADDRREG_READ	0x00100000	/* Read from tank memory			*/
868 
869 #define MICROCODEBASE		0x400		/* Microcode data base address			*/
870 
871 /* Each DSP microcode instruction is mapped into 2 doublewords 					*/
872 /* NOTE: When writing, always write the LO doubleword first.  Reads can be in either order.	*/
873 #define LOWORD_OPX_MASK		0x000ffc00	/* Instruction operand X			*/
874 #define LOWORD_OPY_MASK		0x000003ff	/* Instruction operand Y			*/
875 #define HIWORD_OPCODE_MASK	0x00f00000	/* Instruction opcode				*/
876 #define HIWORD_RESULT_MASK	0x000ffc00	/* Instruction result				*/
877 #define HIWORD_OPA_MASK		0x000003ff	/* Instruction operand A			*/
878 
879 
880 /* Audigy Soundcard have a different instruction format */
881 #define A_MICROCODEBASE		0x600
882 #define A_LOWORD_OPY_MASK	0x000007ff
883 #define A_LOWORD_OPX_MASK	0x007ff000
884 #define A_HIWORD_OPCODE_MASK	0x0f000000
885 #define A_HIWORD_RESULT_MASK	0x007ff000
886 #define A_HIWORD_OPA_MASK	0x000007ff
887 
888 
889 /* ------------------- STRUCTURES -------------------- */
890 
891 enum {
892 	EMU10K1_EFX,
893 	EMU10K1_PCM,
894 	EMU10K1_SYNTH,
895 	EMU10K1_MIDI
896 };
897 
898 struct snd_emu10k1;
899 
900 struct snd_emu10k1_voice {
901 	struct snd_emu10k1 *emu;
902 	int number;
903 	unsigned int use: 1,
904 	    pcm: 1,
905 	    efx: 1,
906 	    synth: 1,
907 	    midi: 1;
908 	void (*interrupt)(struct snd_emu10k1 *emu, struct snd_emu10k1_voice *pvoice);
909 
910 	struct snd_emu10k1_pcm *epcm;
911 };
912 
913 enum {
914 	PLAYBACK_EMUVOICE,
915 	PLAYBACK_EFX,
916 	CAPTURE_AC97ADC,
917 	CAPTURE_AC97MIC,
918 	CAPTURE_EFX
919 };
920 
921 struct snd_emu10k1_pcm {
922 	struct snd_emu10k1 *emu;
923 	int type;
924 	struct snd_pcm_substream *substream;
925 	struct snd_emu10k1_voice *voices[NUM_EFX_PLAYBACK];
926 	struct snd_emu10k1_voice *extra;
927 	unsigned short running;
928 	unsigned short first_ptr;
929 	struct snd_util_memblk *memblk;
930 	unsigned int start_addr;
931 	unsigned int ccca_start_addr;
932 	unsigned int capture_ipr;	/* interrupt acknowledge mask */
933 	unsigned int capture_inte;	/* interrupt enable mask */
934 	unsigned int capture_ba_reg;	/* buffer address register */
935 	unsigned int capture_bs_reg;	/* buffer size register */
936 	unsigned int capture_idx_reg;	/* buffer index register */
937 	unsigned int capture_cr_val;	/* control value */
938 	unsigned int capture_cr_val2;	/* control value2 (for audigy) */
939 	unsigned int capture_bs_val;	/* buffer size value */
940 	unsigned int capture_bufsize;	/* buffer size in bytes */
941 };
942 
943 struct snd_emu10k1_pcm_mixer {
944 	/* mono, left, right x 8 sends (4 on emu10k1) */
945 	unsigned char send_routing[3][8];
946 	unsigned char send_volume[3][8];
947 	unsigned short attn[3];
948 	struct snd_emu10k1_pcm *epcm;
949 };
950 
951 #define snd_emu10k1_compose_send_routing(route) \
952 ((route[0] | (route[1] << 4) | (route[2] << 8) | (route[3] << 12)) << 16)
953 
954 #define snd_emu10k1_compose_audigy_fxrt1(route) \
955 ((unsigned int)route[0] | ((unsigned int)route[1] << 8) | ((unsigned int)route[2] << 16) | ((unsigned int)route[3] << 24))
956 
957 #define snd_emu10k1_compose_audigy_fxrt2(route) \
958 ((unsigned int)route[4] | ((unsigned int)route[5] << 8) | ((unsigned int)route[6] << 16) | ((unsigned int)route[7] << 24))
959 
960 struct snd_emu10k1_memblk {
961 	struct snd_util_memblk mem;
962 	/* private part */
963 	int first_page, last_page, pages, mapped_page;
964 	unsigned int map_locked;
965 	struct list_head mapped_link;
966 	struct list_head mapped_order_link;
967 };
968 
969 #define snd_emu10k1_memblk_offset(blk)	(((blk)->mapped_page << PAGE_SHIFT) | ((blk)->mem.offset & (PAGE_SIZE - 1)))
970 
971 #define EMU10K1_MAX_TRAM_BLOCKS_PER_CODE	16
972 
973 struct snd_emu10k1_fx8010_ctl {
974 	struct list_head list;		/* list link container */
975 	unsigned int vcount;
976 	unsigned int count;		/* count of GPR (1..16) */
977 	unsigned short gpr[32];		/* GPR number(s) */
978 	unsigned int value[32];
979 	unsigned int min;		/* minimum range */
980 	unsigned int max;		/* maximum range */
981 	unsigned int translation;	/* translation type (EMU10K1_GPR_TRANSLATION*) */
982 	struct snd_kcontrol *kcontrol;
983 };
984 
985 typedef void (snd_fx8010_irq_handler_t)(struct snd_emu10k1 *emu, void *private_data);
986 
987 struct snd_emu10k1_fx8010_irq {
988 	struct snd_emu10k1_fx8010_irq *next;
989 	snd_fx8010_irq_handler_t *handler;
990 	unsigned short gpr_running;
991 	void *private_data;
992 };
993 
994 struct snd_emu10k1_fx8010_pcm {
995 	unsigned int valid: 1,
996 		     opened: 1,
997 		     active: 1;
998 	unsigned int channels;		/* 16-bit channels count */
999 	unsigned int tram_start;	/* initial ring buffer position in TRAM (in samples) */
1000 	unsigned int buffer_size;	/* count of buffered samples */
1001 	unsigned short gpr_size;		/* GPR containing size of ring buffer in samples (host) */
1002 	unsigned short gpr_ptr;		/* GPR containing current pointer in the ring buffer (host = reset, FX8010) */
1003 	unsigned short gpr_count;	/* GPR containing count of samples between two interrupts (host) */
1004 	unsigned short gpr_tmpcount;	/* GPR containing current count of samples to interrupt (host = set, FX8010) */
1005 	unsigned short gpr_trigger;	/* GPR containing trigger (activate) information (host) */
1006 	unsigned short gpr_running;	/* GPR containing info if PCM is running (FX8010) */
1007 	unsigned char etram[32];	/* external TRAM address & data */
1008 	struct snd_pcm_indirect pcm_rec;
1009 	unsigned int tram_pos;
1010 	unsigned int tram_shift;
1011 	struct snd_emu10k1_fx8010_irq *irq;
1012 };
1013 
1014 struct snd_emu10k1_fx8010 {
1015 	unsigned short fxbus_mask;	/* used FX buses (bitmask) */
1016 	unsigned short extin_mask;	/* used external inputs (bitmask) */
1017 	unsigned short extout_mask;	/* used external outputs (bitmask) */
1018 	unsigned short pad1;
1019 	unsigned int itram_size;	/* internal TRAM size in samples */
1020 	struct snd_dma_buffer etram_pages; /* external TRAM pages and size */
1021 	unsigned int dbg;		/* FX debugger register */
1022 	unsigned char name[128];
1023 	int gpr_size;			/* size of allocated GPR controls */
1024 	int gpr_count;			/* count of used kcontrols */
1025 	struct list_head gpr_ctl;	/* GPR controls */
1026 	struct mutex lock;
1027 	struct snd_emu10k1_fx8010_pcm pcm[8];
1028 	spinlock_t irq_lock;
1029 	struct snd_emu10k1_fx8010_irq *irq_handlers;
1030 };
1031 
1032 #define emu10k1_gpr_ctl(n) list_entry(n, struct snd_emu10k1_fx8010_ctl, list)
1033 
1034 struct snd_emu10k1_midi {
1035 	struct snd_emu10k1 *emu;
1036 	struct snd_rawmidi *rmidi;
1037 	struct snd_rawmidi_substream *substream_input;
1038 	struct snd_rawmidi_substream *substream_output;
1039 	unsigned int midi_mode;
1040 	spinlock_t input_lock;
1041 	spinlock_t output_lock;
1042 	spinlock_t open_lock;
1043 	int tx_enable, rx_enable;
1044 	int port;
1045 	int ipr_tx, ipr_rx;
1046 	void (*interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1047 };
1048 
1049 struct snd_emu_chip_details {
1050 	u32 vendor;
1051 	u32 device;
1052 	u32 subsystem;
1053 	unsigned char revision;
1054 	unsigned char emu10k1_chip; /* Original SB Live. Not SB Live 24bit. */
1055 	unsigned char emu10k2_chip; /* Audigy 1 or Audigy 2. */
1056 	unsigned char ca0102_chip;  /* Audigy 1 or Audigy 2. Not SB Audigy 2 Value. */
1057 	unsigned char ca0108_chip;  /* Audigy 2 Value */
1058 	unsigned char ca_cardbus_chip; /* Audigy 2 ZS Notebook */
1059 	unsigned char ca0151_chip;  /* P16V */
1060 	unsigned char spk71;        /* Has 7.1 speakers */
1061 	unsigned char sblive51;	    /* SBLive! 5.1 - extout 0x11 -> center, 0x12 -> lfe */
1062 	unsigned char spdif_bug;    /* Has Spdif phasing bug */
1063 	unsigned char ac97_chip;    /* Has an AC97 chip: 1 = mandatory, 2 = optional */
1064 	unsigned char ecard;        /* APS EEPROM */
1065 	unsigned char emu1212m;     /* EMU 1212m card */
1066 	unsigned char spi_dac;      /* SPI interface for DAC */
1067 	unsigned char i2c_adc;      /* I2C interface for ADC */
1068 	const char *driver;
1069 	const char *name;
1070 	const char *id;		/* for backward compatibility - can be NULL if not needed */
1071 };
1072 
1073 struct snd_emu10k1 {
1074 	int irq;
1075 
1076 	unsigned long port;			/* I/O port number */
1077 	unsigned int tos_link: 1,		/* tos link detected */
1078 		rear_ac97: 1,			/* rear channels are on AC'97 */
1079 		enable_ir: 1;
1080 	/* Contains profile of card capabilities */
1081 	const struct snd_emu_chip_details *card_capabilities;
1082 	unsigned int audigy;			/* is Audigy? */
1083 	unsigned int revision;			/* chip revision */
1084 	unsigned int serial;			/* serial number */
1085 	unsigned short model;			/* subsystem id */
1086 	unsigned int card_type;			/* EMU10K1_CARD_* */
1087 	unsigned int ecard_ctrl;		/* ecard control bits */
1088 	unsigned long dma_mask;			/* PCI DMA mask */
1089 	int max_cache_pages;			/* max memory size / PAGE_SIZE */
1090 	struct snd_dma_buffer silent_page;	/* silent page */
1091 	struct snd_dma_buffer ptb_pages;	/* page table pages */
1092 	struct snd_dma_device p16v_dma_dev;
1093 	struct snd_dma_buffer p16v_buffer;
1094 
1095 	struct snd_util_memhdr *memhdr;		/* page allocation list */
1096 	struct snd_emu10k1_memblk *reserved_page;	/* reserved page */
1097 
1098 	struct list_head mapped_link_head;
1099 	struct list_head mapped_order_link_head;
1100 	void **page_ptr_table;
1101 	unsigned long *page_addr_table;
1102 	spinlock_t memblk_lock;
1103 
1104 	unsigned int spdif_bits[3];		/* s/pdif out setup */
1105 
1106 	struct snd_emu10k1_fx8010 fx8010;		/* FX8010 info */
1107 	int gpr_base;
1108 
1109 	struct snd_ac97 *ac97;
1110 
1111 	struct pci_dev *pci;
1112 	struct snd_card *card;
1113 	struct snd_pcm *pcm;
1114 	struct snd_pcm *pcm_mic;
1115 	struct snd_pcm *pcm_efx;
1116 	struct snd_pcm *pcm_multi;
1117 	struct snd_pcm *pcm_p16v;
1118 
1119 	spinlock_t synth_lock;
1120 	void *synth;
1121 	int (*get_synth_voice)(struct snd_emu10k1 *emu);
1122 
1123 	spinlock_t reg_lock;
1124 	spinlock_t emu_lock;
1125 	spinlock_t voice_lock;
1126 
1127 	struct snd_emu10k1_voice voices[NUM_G];
1128 	struct snd_emu10k1_voice p16v_voices[4];
1129 	struct snd_emu10k1_voice p16v_capture_voice;
1130 	int p16v_device_offset;
1131 	u32 p16v_capture_source;
1132 	u32 p16v_capture_channel;
1133 	struct snd_emu10k1_pcm_mixer pcm_mixer[32];
1134 	struct snd_emu10k1_pcm_mixer efx_pcm_mixer[NUM_EFX_PLAYBACK];
1135 	struct snd_kcontrol *ctl_send_routing;
1136 	struct snd_kcontrol *ctl_send_volume;
1137 	struct snd_kcontrol *ctl_attn;
1138 	struct snd_kcontrol *ctl_efx_send_routing;
1139 	struct snd_kcontrol *ctl_efx_send_volume;
1140 	struct snd_kcontrol *ctl_efx_attn;
1141 
1142 	void (*hwvol_interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1143 	void (*capture_interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1144 	void (*capture_mic_interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1145 	void (*capture_efx_interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1146 	void (*spdif_interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1147 	void (*dsp_interrupt)(struct snd_emu10k1 *emu);
1148 
1149 	struct snd_pcm_substream *pcm_capture_substream;
1150 	struct snd_pcm_substream *pcm_capture_mic_substream;
1151 	struct snd_pcm_substream *pcm_capture_efx_substream;
1152 	struct snd_pcm_substream *pcm_playback_efx_substream;
1153 
1154 	struct snd_timer *timer;
1155 
1156 	struct snd_emu10k1_midi midi;
1157 	struct snd_emu10k1_midi midi2; /* for audigy */
1158 
1159 	unsigned int efx_voices_mask[2];
1160 	unsigned int next_free_voice;
1161 
1162 #ifdef CONFIG_PM
1163 	unsigned int *saved_ptr;
1164 	unsigned int *saved_gpr;
1165 	unsigned int *tram_val_saved;
1166 	unsigned int *tram_addr_saved;
1167 	unsigned int *saved_icode;
1168 	unsigned int *p16v_saved;
1169 	unsigned int saved_a_iocfg, saved_hcfg;
1170 #endif
1171 
1172 };
1173 
1174 int snd_emu10k1_create(struct snd_card *card,
1175 		       struct pci_dev *pci,
1176 		       unsigned short extin_mask,
1177 		       unsigned short extout_mask,
1178 		       long max_cache_bytes,
1179 		       int enable_ir,
1180 		       uint subsystem,
1181 		       struct snd_emu10k1 ** remu);
1182 
1183 int snd_emu10k1_pcm(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1184 int snd_emu10k1_pcm_mic(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1185 int snd_emu10k1_pcm_efx(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1186 int snd_p16v_pcm(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1187 int snd_p16v_free(struct snd_emu10k1 * emu);
1188 int snd_p16v_mixer(struct snd_emu10k1 * emu);
1189 int snd_emu10k1_pcm_multi(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1190 int snd_emu10k1_fx8010_pcm(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1191 int snd_emu10k1_mixer(struct snd_emu10k1 * emu, int pcm_device, int multi_device);
1192 int snd_emu10k1_timer(struct snd_emu10k1 * emu, int device);
1193 int snd_emu10k1_fx8010_new(struct snd_emu10k1 *emu, int device, struct snd_hwdep ** rhwdep);
1194 
1195 irqreturn_t snd_emu10k1_interrupt(int irq, void *dev_id, struct pt_regs *regs);
1196 
1197 void snd_emu10k1_voice_init(struct snd_emu10k1 * emu, int voice);
1198 int snd_emu10k1_init_efx(struct snd_emu10k1 *emu);
1199 void snd_emu10k1_free_efx(struct snd_emu10k1 *emu);
1200 int snd_emu10k1_fx8010_tram_setup(struct snd_emu10k1 *emu, u32 size);
1201 int snd_emu10k1_done(struct snd_emu10k1 * emu);
1202 
1203 /* I/O functions */
1204 unsigned int snd_emu10k1_ptr_read(struct snd_emu10k1 * emu, unsigned int reg, unsigned int chn);
1205 void snd_emu10k1_ptr_write(struct snd_emu10k1 *emu, unsigned int reg, unsigned int chn, unsigned int data);
1206 unsigned int snd_emu10k1_ptr20_read(struct snd_emu10k1 * emu, unsigned int reg, unsigned int chn);
1207 void snd_emu10k1_ptr20_write(struct snd_emu10k1 *emu, unsigned int reg, unsigned int chn, unsigned int data);
1208 int snd_emu10k1_spi_write(struct snd_emu10k1 * emu, unsigned int data);
1209 unsigned int snd_emu10k1_efx_read(struct snd_emu10k1 *emu, unsigned int pc);
1210 void snd_emu10k1_intr_enable(struct snd_emu10k1 *emu, unsigned int intrenb);
1211 void snd_emu10k1_intr_disable(struct snd_emu10k1 *emu, unsigned int intrenb);
1212 void snd_emu10k1_voice_intr_enable(struct snd_emu10k1 *emu, unsigned int voicenum);
1213 void snd_emu10k1_voice_intr_disable(struct snd_emu10k1 *emu, unsigned int voicenum);
1214 void snd_emu10k1_voice_intr_ack(struct snd_emu10k1 *emu, unsigned int voicenum);
1215 void snd_emu10k1_voice_half_loop_intr_enable(struct snd_emu10k1 *emu, unsigned int voicenum);
1216 void snd_emu10k1_voice_half_loop_intr_disable(struct snd_emu10k1 *emu, unsigned int voicenum);
1217 void snd_emu10k1_voice_half_loop_intr_ack(struct snd_emu10k1 *emu, unsigned int voicenum);
1218 void snd_emu10k1_voice_set_loop_stop(struct snd_emu10k1 *emu, unsigned int voicenum);
1219 void snd_emu10k1_voice_clear_loop_stop(struct snd_emu10k1 *emu, unsigned int voicenum);
1220 void snd_emu10k1_wait(struct snd_emu10k1 *emu, unsigned int wait);
1221 static inline unsigned int snd_emu10k1_wc(struct snd_emu10k1 *emu) { return (inl(emu->port + WC) >> 6) & 0xfffff; }
1222 unsigned short snd_emu10k1_ac97_read(struct snd_ac97 *ac97, unsigned short reg);
1223 void snd_emu10k1_ac97_write(struct snd_ac97 *ac97, unsigned short reg, unsigned short data);
1224 unsigned int snd_emu10k1_rate_to_pitch(unsigned int rate);
1225 
1226 #ifdef CONFIG_PM
1227 void snd_emu10k1_suspend_regs(struct snd_emu10k1 *emu);
1228 void snd_emu10k1_resume_init(struct snd_emu10k1 *emu);
1229 void snd_emu10k1_resume_regs(struct snd_emu10k1 *emu);
1230 int snd_emu10k1_efx_alloc_pm_buffer(struct snd_emu10k1 *emu);
1231 void snd_emu10k1_efx_free_pm_buffer(struct snd_emu10k1 *emu);
1232 void snd_emu10k1_efx_suspend(struct snd_emu10k1 *emu);
1233 void snd_emu10k1_efx_resume(struct snd_emu10k1 *emu);
1234 int snd_p16v_alloc_pm_buffer(struct snd_emu10k1 *emu);
1235 void snd_p16v_free_pm_buffer(struct snd_emu10k1 *emu);
1236 void snd_p16v_suspend(struct snd_emu10k1 *emu);
1237 void snd_p16v_resume(struct snd_emu10k1 *emu);
1238 #endif
1239 
1240 /* memory allocation */
1241 struct snd_util_memblk *snd_emu10k1_alloc_pages(struct snd_emu10k1 *emu, struct snd_pcm_substream *substream);
1242 int snd_emu10k1_free_pages(struct snd_emu10k1 *emu, struct snd_util_memblk *blk);
1243 struct snd_util_memblk *snd_emu10k1_synth_alloc(struct snd_emu10k1 *emu, unsigned int size);
1244 int snd_emu10k1_synth_free(struct snd_emu10k1 *emu, struct snd_util_memblk *blk);
1245 int snd_emu10k1_synth_bzero(struct snd_emu10k1 *emu, struct snd_util_memblk *blk, int offset, int size);
1246 int snd_emu10k1_synth_copy_from_user(struct snd_emu10k1 *emu, struct snd_util_memblk *blk, int offset, const char __user *data, int size);
1247 int snd_emu10k1_memblk_map(struct snd_emu10k1 *emu, struct snd_emu10k1_memblk *blk);
1248 
1249 /* voice allocation */
1250 int snd_emu10k1_voice_alloc(struct snd_emu10k1 *emu, int type, int pair, struct snd_emu10k1_voice **rvoice);
1251 int snd_emu10k1_voice_free(struct snd_emu10k1 *emu, struct snd_emu10k1_voice *pvoice);
1252 
1253 /* MIDI uart */
1254 int snd_emu10k1_midi(struct snd_emu10k1 * emu);
1255 int snd_emu10k1_audigy_midi(struct snd_emu10k1 * emu);
1256 
1257 /* proc interface */
1258 int snd_emu10k1_proc_init(struct snd_emu10k1 * emu);
1259 
1260 /* fx8010 irq handler */
1261 int snd_emu10k1_fx8010_register_irq_handler(struct snd_emu10k1 *emu,
1262 					    snd_fx8010_irq_handler_t *handler,
1263 					    unsigned char gpr_running,
1264 					    void *private_data,
1265 					    struct snd_emu10k1_fx8010_irq **r_irq);
1266 int snd_emu10k1_fx8010_unregister_irq_handler(struct snd_emu10k1 *emu,
1267 					      struct snd_emu10k1_fx8010_irq *irq);
1268 
1269 #endif /* __KERNEL__ */
1270 
1271 /*
1272  * ---- FX8010 ----
1273  */
1274 
1275 #define EMU10K1_CARD_CREATIVE			0x00000000
1276 #define EMU10K1_CARD_EMUAPS			0x00000001
1277 
1278 #define EMU10K1_FX8010_PCM_COUNT		8
1279 
1280 /* instruction set */
1281 #define iMAC0	 0x00	/* R = A + (X * Y >> 31)   ; saturation */
1282 #define iMAC1	 0x01	/* R = A + (-X * Y >> 31)  ; saturation */
1283 #define iMAC2	 0x02	/* R = A + (X * Y >> 31)   ; wraparound */
1284 #define iMAC3	 0x03	/* R = A + (-X * Y >> 31)  ; wraparound */
1285 #define iMACINT0 0x04	/* R = A + X * Y	   ; saturation */
1286 #define iMACINT1 0x05	/* R = A + X * Y	   ; wraparound (31-bit) */
1287 #define iACC3	 0x06	/* R = A + X + Y	   ; saturation */
1288 #define iMACMV   0x07	/* R = A, acc += X * Y >> 31 */
1289 #define iANDXOR  0x08	/* R = (A & X) ^ Y */
1290 #define iTSTNEG  0x09	/* R = (A >= Y) ? X : ~X */
1291 #define iLIMITGE 0x0a	/* R = (A >= Y) ? X : Y */
1292 #define iLIMITLT 0x0b	/* R = (A < Y) ? X : Y */
1293 #define iLOG	 0x0c	/* R = linear_data, A (log_data), X (max_exp), Y (format_word) */
1294 #define iEXP	 0x0d	/* R = log_data, A (linear_data), X (max_exp), Y (format_word) */
1295 #define iINTERP  0x0e	/* R = A + (X * (Y - A) >> 31)  ; saturation */
1296 #define iSKIP    0x0f	/* R = A (cc_reg), X (count), Y (cc_test) */
1297 
1298 /* GPRs */
1299 #define FXBUS(x)	(0x00 + (x))	/* x = 0x00 - 0x0f */
1300 #define EXTIN(x)	(0x10 + (x))	/* x = 0x00 - 0x0f */
1301 #define EXTOUT(x)	(0x20 + (x))	/* x = 0x00 - 0x0f physical outs -> FXWC low 16 bits */
1302 #define FXBUS2(x)	(0x30 + (x))	/* x = 0x00 - 0x0f copies of fx buses for capture -> FXWC high 16 bits */
1303 					/* NB: 0x31 and 0x32 are shared with Center/LFE on SB live 5.1 */
1304 
1305 #define C_00000000	0x40
1306 #define C_00000001	0x41
1307 #define C_00000002	0x42
1308 #define C_00000003	0x43
1309 #define C_00000004	0x44
1310 #define C_00000008	0x45
1311 #define C_00000010	0x46
1312 #define C_00000020	0x47
1313 #define C_00000100	0x48
1314 #define C_00010000	0x49
1315 #define C_00080000	0x4a
1316 #define C_10000000	0x4b
1317 #define C_20000000	0x4c
1318 #define C_40000000	0x4d
1319 #define C_80000000	0x4e
1320 #define C_7fffffff	0x4f
1321 #define C_ffffffff	0x50
1322 #define C_fffffffe	0x51
1323 #define C_c0000000	0x52
1324 #define C_4f1bbcdc	0x53
1325 #define C_5a7ef9db	0x54
1326 #define C_00100000	0x55		/* ?? */
1327 #define GPR_ACCU	0x56		/* ACCUM, accumulator */
1328 #define GPR_COND	0x57		/* CCR, condition register */
1329 #define GPR_NOISE0	0x58		/* noise source */
1330 #define GPR_NOISE1	0x59		/* noise source */
1331 #define GPR_IRQ		0x5a		/* IRQ register */
1332 #define GPR_DBAC	0x5b		/* TRAM Delay Base Address Counter */
1333 #define GPR(x)		(FXGPREGBASE + (x)) /* free GPRs: x = 0x00 - 0xff */
1334 #define ITRAM_DATA(x)	(TANKMEMDATAREGBASE + 0x00 + (x)) /* x = 0x00 - 0x7f */
1335 #define ETRAM_DATA(x)	(TANKMEMDATAREGBASE + 0x80 + (x)) /* x = 0x00 - 0x1f */
1336 #define ITRAM_ADDR(x)	(TANKMEMADDRREGBASE + 0x00 + (x)) /* x = 0x00 - 0x7f */
1337 #define ETRAM_ADDR(x)	(TANKMEMADDRREGBASE + 0x80 + (x)) /* x = 0x00 - 0x1f */
1338 
1339 #define A_ITRAM_DATA(x)	(TANKMEMDATAREGBASE + 0x00 + (x)) /* x = 0x00 - 0xbf */
1340 #define A_ETRAM_DATA(x)	(TANKMEMDATAREGBASE + 0xc0 + (x)) /* x = 0x00 - 0x3f */
1341 #define A_ITRAM_ADDR(x)	(TANKMEMADDRREGBASE + 0x00 + (x)) /* x = 0x00 - 0xbf */
1342 #define A_ETRAM_ADDR(x)	(TANKMEMADDRREGBASE + 0xc0 + (x)) /* x = 0x00 - 0x3f */
1343 #define A_ITRAM_CTL(x)	(A_TANKMEMCTLREGBASE + 0x00 + (x)) /* x = 0x00 - 0xbf */
1344 #define A_ETRAM_CTL(x)	(A_TANKMEMCTLREGBASE + 0xc0 + (x)) /* x = 0x00 - 0x3f */
1345 
1346 #define A_FXBUS(x)	(0x00 + (x))	/* x = 0x00 - 0x3f FX buses */
1347 #define A_EXTIN(x)	(0x40 + (x))	/* x = 0x00 - 0x0f physical ins */
1348 #define A_P16VIN(x)	(0x50 + (x))	/* x = 0x00 - 0x0f p16v ins (A2 only) "EMU32 inputs" */
1349 #define A_EXTOUT(x)	(0x60 + (x))	/* x = 0x00 - 0x1f physical outs -> A_FXWC1 0x79-7f unknown   */
1350 #define A_FXBUS2(x)	(0x80 + (x))	/* x = 0x00 - 0x1f extra outs used for EFX capture -> A_FXWC2 */
1351 #define A_EMU32OUTH(x)	(0xa0 + (x))	/* x = 0x00 - 0x0f "EMU32_OUT_10 - _1F" - ??? */
1352 #define A_EMU32OUTL(x)	(0xb0 + (x))	/* x = 0x00 - 0x0f "EMU32_OUT_1 - _F" - ??? */
1353 #define A_GPR(x)	(A_FXGPREGBASE + (x))
1354 
1355 /* cc_reg constants */
1356 #define CC_REG_NORMALIZED C_00000001
1357 #define CC_REG_BORROW	C_00000002
1358 #define CC_REG_MINUS	C_00000004
1359 #define CC_REG_ZERO	C_00000008
1360 #define CC_REG_SATURATE	C_00000010
1361 #define CC_REG_NONZERO	C_00000100
1362 
1363 /* FX buses */
1364 #define FXBUS_PCM_LEFT		0x00
1365 #define FXBUS_PCM_RIGHT		0x01
1366 #define FXBUS_PCM_LEFT_REAR	0x02
1367 #define FXBUS_PCM_RIGHT_REAR	0x03
1368 #define FXBUS_MIDI_LEFT		0x04
1369 #define FXBUS_MIDI_RIGHT	0x05
1370 #define FXBUS_PCM_CENTER	0x06
1371 #define FXBUS_PCM_LFE		0x07
1372 #define FXBUS_PCM_LEFT_FRONT	0x08
1373 #define FXBUS_PCM_RIGHT_FRONT	0x09
1374 #define FXBUS_MIDI_REVERB	0x0c
1375 #define FXBUS_MIDI_CHORUS	0x0d
1376 #define FXBUS_PCM_LEFT_SIDE	0x0e
1377 #define FXBUS_PCM_RIGHT_SIDE	0x0f
1378 #define FXBUS_PT_LEFT		0x14
1379 #define FXBUS_PT_RIGHT		0x15
1380 
1381 /* Inputs */
1382 #define EXTIN_AC97_L	   0x00	/* AC'97 capture channel - left */
1383 #define EXTIN_AC97_R	   0x01	/* AC'97 capture channel - right */
1384 #define EXTIN_SPDIF_CD_L   0x02	/* internal S/PDIF CD - onboard - left */
1385 #define EXTIN_SPDIF_CD_R   0x03	/* internal S/PDIF CD - onboard - right */
1386 #define EXTIN_ZOOM_L	   0x04	/* Zoom Video I2S - left */
1387 #define EXTIN_ZOOM_R	   0x05	/* Zoom Video I2S - right */
1388 #define EXTIN_TOSLINK_L	   0x06	/* LiveDrive - TOSLink Optical - left */
1389 #define EXTIN_TOSLINK_R    0x07	/* LiveDrive - TOSLink Optical - right */
1390 #define EXTIN_LINE1_L	   0x08	/* LiveDrive - Line/Mic 1 - left */
1391 #define EXTIN_LINE1_R	   0x09	/* LiveDrive - Line/Mic 1 - right */
1392 #define EXTIN_COAX_SPDIF_L 0x0a	/* LiveDrive - Coaxial S/PDIF - left */
1393 #define EXTIN_COAX_SPDIF_R 0x0b /* LiveDrive - Coaxial S/PDIF - right */
1394 #define EXTIN_LINE2_L	   0x0c	/* LiveDrive - Line/Mic 2 - left */
1395 #define EXTIN_LINE2_R	   0x0d	/* LiveDrive - Line/Mic 2 - right */
1396 
1397 /* Outputs */
1398 #define EXTOUT_AC97_L	   0x00	/* AC'97 playback channel - left */
1399 #define EXTOUT_AC97_R	   0x01	/* AC'97 playback channel - right */
1400 #define EXTOUT_TOSLINK_L   0x02	/* LiveDrive - TOSLink Optical - left */
1401 #define EXTOUT_TOSLINK_R   0x03	/* LiveDrive - TOSLink Optical - right */
1402 #define EXTOUT_AC97_CENTER 0x04	/* SB Live 5.1 - center */
1403 #define EXTOUT_AC97_LFE	   0x05 /* SB Live 5.1 - LFE */
1404 #define EXTOUT_HEADPHONE_L 0x06	/* LiveDrive - Headphone - left */
1405 #define EXTOUT_HEADPHONE_R 0x07	/* LiveDrive - Headphone - right */
1406 #define EXTOUT_REAR_L	   0x08	/* Rear channel - left */
1407 #define EXTOUT_REAR_R	   0x09	/* Rear channel - right */
1408 #define EXTOUT_ADC_CAP_L   0x0a	/* ADC Capture buffer - left */
1409 #define EXTOUT_ADC_CAP_R   0x0b	/* ADC Capture buffer - right */
1410 #define EXTOUT_MIC_CAP	   0x0c	/* MIC Capture buffer */
1411 #define EXTOUT_AC97_REAR_L 0x0d	/* SB Live 5.1 (c) 2003 - Rear Left */
1412 #define EXTOUT_AC97_REAR_R 0x0e	/* SB Live 5.1 (c) 2003 - Rear Right */
1413 #define EXTOUT_ACENTER	   0x11 /* Analog Center */
1414 #define EXTOUT_ALFE	   0x12 /* Analog LFE */
1415 
1416 /* Audigy Inputs */
1417 #define A_EXTIN_AC97_L		0x00	/* AC'97 capture channel - left */
1418 #define A_EXTIN_AC97_R		0x01	/* AC'97 capture channel - right */
1419 #define A_EXTIN_SPDIF_CD_L	0x02	/* digital CD left */
1420 #define A_EXTIN_SPDIF_CD_R	0x03	/* digital CD left */
1421 #define A_EXTIN_OPT_SPDIF_L     0x04    /* audigy drive Optical SPDIF - left */
1422 #define A_EXTIN_OPT_SPDIF_R     0x05    /*                              right */
1423 #define A_EXTIN_LINE2_L		0x08	/* audigy drive line2/mic2 - left */
1424 #define A_EXTIN_LINE2_R		0x09	/*                           right */
1425 #define A_EXTIN_ADC_L		0x0a    /* Philips ADC - left */
1426 #define A_EXTIN_ADC_R		0x0b    /*               right */
1427 #define A_EXTIN_AUX2_L		0x0c	/* audigy drive aux2 - left */
1428 #define A_EXTIN_AUX2_R		0x0d	/*                   - right */
1429 
1430 /* Audigiy Outputs */
1431 #define A_EXTOUT_FRONT_L	0x00	/* digital front left */
1432 #define A_EXTOUT_FRONT_R	0x01	/*               right */
1433 #define A_EXTOUT_CENTER		0x02	/* digital front center */
1434 #define A_EXTOUT_LFE		0x03	/* digital front lfe */
1435 #define A_EXTOUT_HEADPHONE_L	0x04	/* headphone audigy drive left */
1436 #define A_EXTOUT_HEADPHONE_R	0x05	/*                        right */
1437 #define A_EXTOUT_REAR_L		0x06	/* digital rear left */
1438 #define A_EXTOUT_REAR_R		0x07	/*              right */
1439 #define A_EXTOUT_AFRONT_L	0x08	/* analog front left */
1440 #define A_EXTOUT_AFRONT_R	0x09	/*              right */
1441 #define A_EXTOUT_ACENTER	0x0a	/* analog center */
1442 #define A_EXTOUT_ALFE		0x0b	/* analog LFE */
1443 #define A_EXTOUT_ASIDE_L	0x0c	/* analog side left  - Audigy 2 ZS */
1444 #define A_EXTOUT_ASIDE_R	0x0d	/*             right - Audigy 2 ZS */
1445 #define A_EXTOUT_AREAR_L	0x0e	/* analog rear left */
1446 #define A_EXTOUT_AREAR_R	0x0f	/*             right */
1447 #define A_EXTOUT_AC97_L		0x10	/* AC97 left (front) */
1448 #define A_EXTOUT_AC97_R		0x11	/*      right */
1449 #define A_EXTOUT_ADC_CAP_L	0x16	/* ADC capture buffer left */
1450 #define A_EXTOUT_ADC_CAP_R	0x17	/*                    right */
1451 #define A_EXTOUT_MIC_CAP	0x18	/* Mic capture buffer */
1452 
1453 /* Audigy constants */
1454 #define A_C_00000000	0xc0
1455 #define A_C_00000001	0xc1
1456 #define A_C_00000002	0xc2
1457 #define A_C_00000003	0xc3
1458 #define A_C_00000004	0xc4
1459 #define A_C_00000008	0xc5
1460 #define A_C_00000010	0xc6
1461 #define A_C_00000020	0xc7
1462 #define A_C_00000100	0xc8
1463 #define A_C_00010000	0xc9
1464 #define A_C_00000800	0xca
1465 #define A_C_10000000	0xcb
1466 #define A_C_20000000	0xcc
1467 #define A_C_40000000	0xcd
1468 #define A_C_80000000	0xce
1469 #define A_C_7fffffff	0xcf
1470 #define A_C_ffffffff	0xd0
1471 #define A_C_fffffffe	0xd1
1472 #define A_C_c0000000	0xd2
1473 #define A_C_4f1bbcdc	0xd3
1474 #define A_C_5a7ef9db	0xd4
1475 #define A_C_00100000	0xd5
1476 #define A_GPR_ACCU	0xd6		/* ACCUM, accumulator */
1477 #define A_GPR_COND	0xd7		/* CCR, condition register */
1478 #define A_GPR_NOISE0	0xd8		/* noise source */
1479 #define A_GPR_NOISE1	0xd9		/* noise source */
1480 #define A_GPR_IRQ	0xda		/* IRQ register */
1481 #define A_GPR_DBAC	0xdb		/* TRAM Delay Base Address Counter - internal */
1482 #define A_GPR_DBACE	0xde		/* TRAM Delay Base Address Counter - external */
1483 
1484 /* definitions for debug register */
1485 #define EMU10K1_DBG_ZC			0x80000000	/* zero tram counter */
1486 #define EMU10K1_DBG_SATURATION_OCCURED	0x02000000	/* saturation control */
1487 #define EMU10K1_DBG_SATURATION_ADDR	0x01ff0000	/* saturation address */
1488 #define EMU10K1_DBG_SINGLE_STEP		0x00008000	/* single step mode */
1489 #define EMU10K1_DBG_STEP		0x00004000	/* start single step */
1490 #define EMU10K1_DBG_CONDITION_CODE	0x00003e00	/* condition code */
1491 #define EMU10K1_DBG_SINGLE_STEP_ADDR	0x000001ff	/* single step address */
1492 
1493 /* tank memory address line */
1494 #ifndef __KERNEL__
1495 #define TANKMEMADDRREG_ADDR_MASK 0x000fffff	/* 20 bit tank address field			*/
1496 #define TANKMEMADDRREG_CLEAR	 0x00800000	/* Clear tank memory				*/
1497 #define TANKMEMADDRREG_ALIGN	 0x00400000	/* Align read or write relative to tank access	*/
1498 #define TANKMEMADDRREG_WRITE	 0x00200000	/* Write to tank memory				*/
1499 #define TANKMEMADDRREG_READ	 0x00100000	/* Read from tank memory			*/
1500 #endif
1501 
1502 struct snd_emu10k1_fx8010_info {
1503 	unsigned int internal_tram_size;	/* in samples */
1504 	unsigned int external_tram_size;	/* in samples */
1505 	char fxbus_names[16][32];		/* names of FXBUSes */
1506 	char extin_names[16][32];		/* names of external inputs */
1507 	char extout_names[32][32];		/* names of external outputs */
1508 	unsigned int gpr_controls;		/* count of GPR controls */
1509 };
1510 
1511 #define EMU10K1_GPR_TRANSLATION_NONE		0
1512 #define EMU10K1_GPR_TRANSLATION_TABLE100	1
1513 #define EMU10K1_GPR_TRANSLATION_BASS		2
1514 #define EMU10K1_GPR_TRANSLATION_TREBLE		3
1515 #define EMU10K1_GPR_TRANSLATION_ONOFF		4
1516 
1517 struct snd_emu10k1_fx8010_control_gpr {
1518 	struct snd_ctl_elem_id id;		/* full control ID definition */
1519 	unsigned int vcount;		/* visible count */
1520 	unsigned int count;		/* count of GPR (1..16) */
1521 	unsigned short gpr[32];		/* GPR number(s) */
1522 	unsigned int value[32];		/* initial values */
1523 	unsigned int min;		/* minimum range */
1524 	unsigned int max;		/* maximum range */
1525 	unsigned int translation;	/* translation type (EMU10K1_GPR_TRANSLATION*) */
1526 };
1527 
1528 struct snd_emu10k1_fx8010_code {
1529 	char name[128];
1530 
1531 	DECLARE_BITMAP(gpr_valid, 0x200); /* bitmask of valid initializers */
1532 	u_int32_t __user *gpr_map;	  /* initializers */
1533 
1534 	unsigned int gpr_add_control_count; /* count of GPR controls to add/replace */
1535 	struct snd_emu10k1_fx8010_control_gpr __user *gpr_add_controls; /* GPR controls to add/replace */
1536 
1537 	unsigned int gpr_del_control_count; /* count of GPR controls to remove */
1538 	struct snd_ctl_elem_id __user *gpr_del_controls; /* IDs of GPR controls to remove */
1539 
1540 	unsigned int gpr_list_control_count; /* count of GPR controls to list */
1541 	unsigned int gpr_list_control_total; /* total count of GPR controls */
1542 	struct snd_emu10k1_fx8010_control_gpr __user *gpr_list_controls; /* listed GPR controls */
1543 
1544 	DECLARE_BITMAP(tram_valid, 0x100); /* bitmask of valid initializers */
1545 	u_int32_t __user *tram_data_map;  /* data initializers */
1546 	u_int32_t __user *tram_addr_map;  /* map initializers */
1547 
1548 	DECLARE_BITMAP(code_valid, 1024); /* bitmask of valid instructions */
1549 	u_int32_t __user *code;		  /* one instruction - 64 bits */
1550 };
1551 
1552 struct snd_emu10k1_fx8010_tram {
1553 	unsigned int address;		/* 31.bit == 1 -> external TRAM */
1554 	unsigned int size;		/* size in samples (4 bytes) */
1555 	unsigned int *samples;		/* pointer to samples (20-bit) */
1556 					/* NULL->clear memory */
1557 };
1558 
1559 struct snd_emu10k1_fx8010_pcm_rec {
1560 	unsigned int substream;		/* substream number */
1561 	unsigned int res1;		/* reserved */
1562 	unsigned int channels;		/* 16-bit channels count, zero = remove this substream */
1563 	unsigned int tram_start;	/* ring buffer position in TRAM (in samples) */
1564 	unsigned int buffer_size;	/* count of buffered samples */
1565 	unsigned short gpr_size;		/* GPR containing size of ringbuffer in samples (host) */
1566 	unsigned short gpr_ptr;		/* GPR containing current pointer in the ring buffer (host = reset, FX8010) */
1567 	unsigned short gpr_count;	/* GPR containing count of samples between two interrupts (host) */
1568 	unsigned short gpr_tmpcount;	/* GPR containing current count of samples to interrupt (host = set, FX8010) */
1569 	unsigned short gpr_trigger;	/* GPR containing trigger (activate) information (host) */
1570 	unsigned short gpr_running;	/* GPR containing info if PCM is running (FX8010) */
1571 	unsigned char pad;		/* reserved */
1572 	unsigned char etram[32];	/* external TRAM address & data (one per channel) */
1573 	unsigned int res2;		/* reserved */
1574 };
1575 
1576 #define SNDRV_EMU10K1_IOCTL_INFO	_IOR ('H', 0x10, struct snd_emu10k1_fx8010_info)
1577 #define SNDRV_EMU10K1_IOCTL_CODE_POKE	_IOW ('H', 0x11, struct snd_emu10k1_fx8010_code)
1578 #define SNDRV_EMU10K1_IOCTL_CODE_PEEK	_IOWR('H', 0x12, struct snd_emu10k1_fx8010_code)
1579 #define SNDRV_EMU10K1_IOCTL_TRAM_SETUP	_IOW ('H', 0x20, int)
1580 #define SNDRV_EMU10K1_IOCTL_TRAM_POKE	_IOW ('H', 0x21, struct snd_emu10k1_fx8010_tram)
1581 #define SNDRV_EMU10K1_IOCTL_TRAM_PEEK	_IOWR('H', 0x22, struct snd_emu10k1_fx8010_tram)
1582 #define SNDRV_EMU10K1_IOCTL_PCM_POKE	_IOW ('H', 0x30, struct snd_emu10k1_fx8010_pcm_rec)
1583 #define SNDRV_EMU10K1_IOCTL_PCM_PEEK	_IOWR('H', 0x31, struct snd_emu10k1_fx8010_pcm_rec)
1584 #define SNDRV_EMU10K1_IOCTL_STOP	_IO  ('H', 0x80)
1585 #define SNDRV_EMU10K1_IOCTL_CONTINUE	_IO  ('H', 0x81)
1586 #define SNDRV_EMU10K1_IOCTL_ZERO_TRAM_COUNTER _IO ('H', 0x82)
1587 #define SNDRV_EMU10K1_IOCTL_SINGLE_STEP	_IOW ('H', 0x83, int)
1588 #define SNDRV_EMU10K1_IOCTL_DBG_READ	_IOR ('H', 0x84, int)
1589 
1590 /* typedefs for compatibility to user-space */
1591 typedef struct snd_emu10k1_fx8010_info emu10k1_fx8010_info_t;
1592 typedef struct snd_emu10k1_fx8010_control_gpr emu10k1_fx8010_control_gpr_t;
1593 typedef struct snd_emu10k1_fx8010_code emu10k1_fx8010_code_t;
1594 typedef struct snd_emu10k1_fx8010_tram emu10k1_fx8010_tram_t;
1595 typedef struct snd_emu10k1_fx8010_pcm_rec emu10k1_fx8010_pcm_t;
1596 
1597 #endif	/* __SOUND_EMU10K1_H */
1598