Merge branch 'linus' of master.kernel.org:/pub/scm/linux/kernel/git/perex/alsa
[sfrench/cifs-2.6.git] / include / sound / emu10k1.h
1 #ifndef __SOUND_EMU10K1_H
2 #define __SOUND_EMU10K1_H
3
4 /*
5  *  Copyright (c) by Jaroslav Kysela <perex@perex.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_PUSH_BUTTON_ENABLE 0x00100000      /* Enables Volume Inc/Dec and Mute functions    */
192 #define HCFG_BAUD_RATE          0x00080000      /* 0 = 48kHz, 1 = 44.1kHz                       */
193 #define HCFG_EXPANDED_MEM       0x00040000      /* 1 = any 16M of 4G addr, 0 = 32M of 2G addr   */
194 #define HCFG_CODECFORMAT_MASK   0x00030000      /* CODEC format                                 */
195
196 /* Specific to Alice2, CA0102 */
197 #define HCFG_CODECFORMAT_AC97_1 0x00000000      /* AC97 CODEC format -- Ver 1.03                */
198 #define HCFG_CODECFORMAT_AC97_2 0x00010000      /* AC97 CODEC format -- Ver 2.1                 */
199 #define HCFG_AUTOMUTE_ASYNC     0x00008000      /* When set, the async sample rate convertors   */
200                                                 /* will automatically mute their output when    */
201                                                 /* they are not rate-locked to the external     */
202                                                 /* async audio source                           */
203 #define HCFG_AUTOMUTE_SPDIF     0x00004000      /* When set, the async sample rate convertors   */
204                                                 /* will automatically mute their output when    */
205                                                 /* the SPDIF V-bit indicates invalid audio      */
206 #define HCFG_EMU32_SLAVE        0x00002000      /* 0 = Master, 1 = Slave. Slave for EMU1010     */
207 #define HCFG_SLOW_RAMP          0x00001000      /* Increases Send Smoothing time constant       */
208 /* 0x00000800 not used on Alice2 */
209 #define HCFG_PHASE_TRACK_MASK   0x00000700      /* When set, forces corresponding input to      */
210                                                 /* phase track the previous input.              */
211                                                 /* I2S0 can phase track the last S/PDIF input   */
212 #define HCFG_I2S_ASRC_ENABLE    0x00000070      /* When set, enables asynchronous sample rate   */
213                                                 /* conversion for the corresponding             */
214                                                 /* I2S format input                             */
215 /* Rest of HCFG 0x0000000f same as below. LOCKSOUNDCACHE etc.  */
216
217
218
219 /* Older chips */
220 #define HCFG_CODECFORMAT_AC97   0x00000000      /* AC97 CODEC format -- Primary Output          */
221 #define HCFG_CODECFORMAT_I2S    0x00010000      /* I2S CODEC format -- Secondary (Rear) Output  */
222 #define HCFG_GPINPUT0           0x00004000      /* External pin112                              */
223 #define HCFG_GPINPUT1           0x00002000      /* External pin110                              */
224 #define HCFG_GPOUTPUT_MASK      0x00001c00      /* External pins which may be controlled        */
225 #define HCFG_GPOUT0             0x00001000      /* External pin? (spdif enable on 5.1)          */
226 #define HCFG_GPOUT1             0x00000800      /* External pin? (IR)                           */
227 #define HCFG_GPOUT2             0x00000400      /* External pin? (IR)                           */
228 #define HCFG_JOYENABLE          0x00000200      /* Internal joystick enable                     */
229 #define HCFG_PHASETRACKENABLE   0x00000100      /* Phase tracking enable                        */
230                                                 /* 1 = Force all 3 async digital inputs to use  */
231                                                 /* the same async sample rate tracker (ZVIDEO)  */
232 #define HCFG_AC3ENABLE_MASK     0x000000e0      /* AC3 async input control - Not implemented    */
233 #define HCFG_AC3ENABLE_ZVIDEO   0x00000080      /* Channels 0 and 1 replace ZVIDEO              */
234 #define HCFG_AC3ENABLE_CDSPDIF  0x00000040      /* Channels 0 and 1 replace CDSPDIF             */
235 #define HCFG_AC3ENABLE_GPSPDIF  0x00000020      /* Channels 0 and 1 replace GPSPDIF             */
236 #define HCFG_AUTOMUTE           0x00000010      /* When set, the async sample rate convertors   */
237                                                 /* will automatically mute their output when    */
238                                                 /* they are not rate-locked to the external     */
239                                                 /* async audio source                           */
240 #define HCFG_LOCKSOUNDCACHE     0x00000008      /* 1 = Cancel bustmaster accesses to soundcache */
241                                                 /* NOTE: This should generally never be used.   */
242 #define HCFG_LOCKTANKCACHE_MASK 0x00000004      /* 1 = Cancel bustmaster accesses to tankcache  */
243                                                 /* NOTE: This should generally never be used.   */
244 #define HCFG_LOCKTANKCACHE      0x01020014
245 #define HCFG_MUTEBUTTONENABLE   0x00000002      /* 1 = Master mute button sets AUDIOENABLE = 0. */
246                                                 /* NOTE: This is a 'cheap' way to implement a   */
247                                                 /* master mute function on the mute button, and */
248                                                 /* in general should not be used unless a more  */
249                                                 /* sophisticated master mute function has not   */
250                                                 /* been written.                                */
251 #define HCFG_AUDIOENABLE        0x00000001      /* 0 = CODECs transmit zero-valued samples      */
252                                                 /* Should be set to 1 when the EMU10K1 is       */
253                                                 /* completely initialized.                      */
254
255 //For Audigy, MPU port move to 0x70-0x74 ptr register
256
257 #define MUDATA                  0x18            /* MPU401 data register (8 bits)                */
258
259 #define MUCMD                   0x19            /* MPU401 command register (8 bits)             */
260 #define MUCMD_RESET             0xff            /* RESET command                                */
261 #define MUCMD_ENTERUARTMODE     0x3f            /* Enter_UART_mode command                      */
262                                                 /* NOTE: All other commands are ignored         */
263
264 #define MUSTAT                  MUCMD           /* MPU401 status register (8 bits)              */
265 #define MUSTAT_IRDYN            0x80            /* 0 = MIDI data or command ACK                 */
266 #define MUSTAT_ORDYN            0x40            /* 0 = MUDATA can accept a command or data      */
267
268 #define A_IOCFG                 0x18            /* GPIO on Audigy card (16bits)                 */
269 #define A_GPINPUT_MASK          0xff00
270 #define A_GPOUTPUT_MASK         0x00ff
271
272 // Audigy output/GPIO stuff taken from the kX drivers
273 #define A_IOCFG_GPOUT0          0x0044          /* analog/digital                               */
274 #define A_IOCFG_DISABLE_ANALOG  0x0040          /* = 'enable' for Audigy2 (chiprev=4)           */
275 #define A_IOCFG_ENABLE_DIGITAL  0x0004
276 #define A_IOCFG_ENABLE_DIGITAL_AUDIGY4  0x0080
277 #define A_IOCFG_UNKNOWN_20      0x0020
278 #define A_IOCFG_DISABLE_AC97_FRONT      0x0080  /* turn off ac97 front -> front (10k2.1)        */
279 #define A_IOCFG_GPOUT1          0x0002          /* IR? drive's internal bypass (?)              */
280 #define A_IOCFG_GPOUT2          0x0001          /* IR */
281 #define A_IOCFG_MULTIPURPOSE_JACK       0x2000  /* center+lfe+rear_center (a2/a2ex)             */
282                                                 /* + digital for generic 10k2                   */
283 #define A_IOCFG_DIGITAL_JACK    0x1000          /* digital for a2 platinum                      */
284 #define A_IOCFG_FRONT_JACK      0x4000
285 #define A_IOCFG_REAR_JACK       0x8000
286 #define A_IOCFG_PHONES_JACK     0x0100          /* LiveDrive                                    */
287
288 /* outputs:
289  *      for audigy2 platinum:   0xa00
290  *      for a2 platinum ex:     0x1c00
291  *      for a1 platinum:        0x0
292  */
293
294 #define TIMER                   0x1a            /* Timer terminal count register                */
295                                                 /* NOTE: After the rate is changed, a maximum   */
296                                                 /* of 1024 sample periods should be allowed     */
297                                                 /* before the new rate is guaranteed accurate.  */
298 #define TIMER_RATE_MASK         0x000003ff      /* Timer interrupt rate in sample periods       */
299                                                 /* 0 == 1024 periods, [1..4] are not useful     */
300 #define TIMER_RATE              0x0a00001a
301
302 #define AC97DATA                0x1c            /* AC97 register set data register (16 bit)     */
303
304 #define AC97ADDRESS             0x1e            /* AC97 register set address register (8 bit)   */
305 #define AC97ADDRESS_READY       0x80            /* Read-only bit, reflects CODEC READY signal   */
306 #define AC97ADDRESS_ADDRESS     0x7f            /* Address of indexed AC97 register             */
307
308 /* Available on the Audigy 2 and Audigy 4 only. This is the P16V chip. */
309 #define PTR2                    0x20            /* Indexed register set pointer register        */
310 #define DATA2                   0x24            /* Indexed register set data register           */
311 #define IPR2                    0x28            /* P16V interrupt pending register              */
312 #define IPR2_PLAYBACK_CH_0_LOOP      0x00001000 /* Playback Channel 0 loop                               */
313 #define IPR2_PLAYBACK_CH_0_HALF_LOOP 0x00000100 /* Playback Channel 0 half loop                          */
314 #define IPR2_CAPTURE_CH_0_LOOP       0x00100000 /* Capture Channel 0 loop                               */
315 #define IPR2_CAPTURE_CH_0_HALF_LOOP  0x00010000 /* Capture Channel 0 half loop                          */
316                                                 /* 0x00000100 Playback. Only in once per period.
317                                                  * 0x00110000 Capture. Int on half buffer.
318                                                  */
319 #define INTE2                   0x2c            /* P16V Interrupt enable register.      */
320 #define INTE2_PLAYBACK_CH_0_LOOP      0x00001000 /* Playback Channel 0 loop                               */
321 #define INTE2_PLAYBACK_CH_0_HALF_LOOP 0x00000100 /* Playback Channel 0 half loop                          */
322 #define INTE2_PLAYBACK_CH_1_LOOP      0x00002000 /* Playback Channel 1 loop                               */
323 #define INTE2_PLAYBACK_CH_1_HALF_LOOP 0x00000200 /* Playback Channel 1 half loop                          */
324 #define INTE2_PLAYBACK_CH_2_LOOP      0x00004000 /* Playback Channel 2 loop                               */
325 #define INTE2_PLAYBACK_CH_2_HALF_LOOP 0x00000400 /* Playback Channel 2 half loop                          */
326 #define INTE2_PLAYBACK_CH_3_LOOP      0x00008000 /* Playback Channel 3 loop                               */
327 #define INTE2_PLAYBACK_CH_3_HALF_LOOP 0x00000800 /* Playback Channel 3 half loop                          */
328 #define INTE2_CAPTURE_CH_0_LOOP       0x00100000 /* Capture Channel 0 loop                               */
329 #define INTE2_CAPTURE_CH_0_HALF_LOOP  0x00010000 /* Caputre Channel 0 half loop                          */
330 #define HCFG2                   0x34            /* Defaults: 0, win2000 sets it to 00004201 */
331                                                 /* 0x00000000 2-channel output. */
332                                                 /* 0x00000200 8-channel output. */
333                                                 /* 0x00000004 pauses stream/irq fail. */
334                                                 /* Rest of bits no nothing to sound output */
335                                                 /* bit 0: Enable P16V audio.
336                                                  * bit 1: Lock P16V record memory cache.
337                                                  * bit 2: Lock P16V playback memory cache.
338                                                  * bit 3: Dummy record insert zero samples.
339                                                  * bit 8: Record 8-channel in phase.
340                                                  * bit 9: Playback 8-channel in phase.
341                                                  * bit 11-12: Playback mixer attenuation: 0=0dB, 1=-6dB, 2=-12dB, 3=Mute.
342                                                  * bit 13: Playback mixer enable.
343                                                  * bit 14: Route SRC48 mixer output to fx engine.
344                                                  * bit 15: Enable IEEE 1394 chip.
345                                                  */
346 #define IPR3                    0x38            /* Cdif interrupt pending register              */
347 #define INTE3                   0x3c            /* Cdif interrupt enable register.      */
348 /************************************************************************************************/
349 /* PCI function 1 registers, address = <val> + PCIBASE1                                         */
350 /************************************************************************************************/
351
352 #define JOYSTICK1               0x00            /* Analog joystick port register                */
353 #define JOYSTICK2               0x01            /* Analog joystick port register                */
354 #define JOYSTICK3               0x02            /* Analog joystick port register                */
355 #define JOYSTICK4               0x03            /* Analog joystick port register                */
356 #define JOYSTICK5               0x04            /* Analog joystick port register                */
357 #define JOYSTICK6               0x05            /* Analog joystick port register                */
358 #define JOYSTICK7               0x06            /* Analog joystick port register                */
359 #define JOYSTICK8               0x07            /* Analog joystick port register                */
360
361 /* When writing, any write causes JOYSTICK_COMPARATOR output enable to be pulsed on write.      */
362 /* When reading, use these bitfields: */
363 #define JOYSTICK_BUTTONS        0x0f            /* Joystick button data                         */
364 #define JOYSTICK_COMPARATOR     0xf0            /* Joystick comparator data                     */
365
366
367 /********************************************************************************************************/
368 /* Emu10k1 pointer-offset register set, accessed through the PTR and DATA registers                     */
369 /********************************************************************************************************/
370
371 #define CPF                     0x00            /* Current pitch and fraction register                  */
372 #define CPF_CURRENTPITCH_MASK   0xffff0000      /* Current pitch (linear, 0x4000 == unity pitch shift)  */
373 #define CPF_CURRENTPITCH        0x10100000
374 #define CPF_STEREO_MASK         0x00008000      /* 1 = Even channel interleave, odd channel locked      */
375 #define CPF_STOP_MASK           0x00004000      /* 1 = Current pitch forced to 0                        */
376 #define CPF_FRACADDRESS_MASK    0x00003fff      /* Linear fractional address of the current channel     */
377
378 #define PTRX                    0x01            /* Pitch target and send A/B amounts register           */
379 #define PTRX_PITCHTARGET_MASK   0xffff0000      /* Pitch target of specified channel                    */
380 #define PTRX_PITCHTARGET        0x10100001
381 #define PTRX_FXSENDAMOUNT_A_MASK 0x0000ff00     /* Linear level of channel output sent to FX send bus A */
382 #define PTRX_FXSENDAMOUNT_A     0x08080001
383 #define PTRX_FXSENDAMOUNT_B_MASK 0x000000ff     /* Linear level of channel output sent to FX send bus B */
384 #define PTRX_FXSENDAMOUNT_B     0x08000001
385
386 #define CVCF                    0x02            /* Current volume and filter cutoff register            */
387 #define CVCF_CURRENTVOL_MASK    0xffff0000      /* Current linear volume of specified channel           */
388 #define CVCF_CURRENTVOL         0x10100002
389 #define CVCF_CURRENTFILTER_MASK 0x0000ffff      /* Current filter cutoff frequency of specified channel */
390 #define CVCF_CURRENTFILTER      0x10000002
391
392 #define VTFT                    0x03            /* Volume target and filter cutoff target register      */
393 #define VTFT_VOLUMETARGET_MASK  0xffff0000      /* Volume target of specified channel                   */
394 #define VTFT_VOLUMETARGET       0x10100003
395 #define VTFT_FILTERTARGET_MASK  0x0000ffff      /* Filter cutoff target of specified channel            */
396 #define VTFT_FILTERTARGET       0x10000003
397
398 #define Z1                      0x05            /* Filter delay memory 1 register                       */
399
400 #define Z2                      0x04            /* Filter delay memory 2 register                       */
401
402 #define PSST                    0x06            /* Send C amount and loop start address register        */
403 #define PSST_FXSENDAMOUNT_C_MASK 0xff000000     /* Linear level of channel output sent to FX send bus C */
404
405 #define PSST_FXSENDAMOUNT_C     0x08180006
406
407 #define PSST_LOOPSTARTADDR_MASK 0x00ffffff      /* Loop start address of the specified channel          */
408 #define PSST_LOOPSTARTADDR      0x18000006
409
410 #define DSL                     0x07            /* Send D amount and loop start address register        */
411 #define DSL_FXSENDAMOUNT_D_MASK 0xff000000      /* Linear level of channel output sent to FX send bus D */
412
413 #define DSL_FXSENDAMOUNT_D      0x08180007
414
415 #define DSL_LOOPENDADDR_MASK    0x00ffffff      /* Loop end address of the specified channel            */
416 #define DSL_LOOPENDADDR         0x18000007
417
418 #define CCCA                    0x08            /* Filter Q, interp. ROM, byte size, cur. addr register */
419 #define CCCA_RESONANCE          0xf0000000      /* Lowpass filter resonance (Q) height                  */
420 #define CCCA_INTERPROMMASK      0x0e000000      /* Selects passband of interpolation ROM                */
421                                                 /* 1 == full band, 7 == lowpass                         */
422                                                 /* ROM 0 is used when pitch shifting downward or less   */
423                                                 /* then 3 semitones upward.  Increasingly higher ROM    */
424                                                 /* numbers are used, typically in steps of 3 semitones, */
425                                                 /* as upward pitch shifting is performed.               */
426 #define CCCA_INTERPROM_0        0x00000000      /* Select interpolation ROM 0                           */
427 #define CCCA_INTERPROM_1        0x02000000      /* Select interpolation ROM 1                           */
428 #define CCCA_INTERPROM_2        0x04000000      /* Select interpolation ROM 2                           */
429 #define CCCA_INTERPROM_3        0x06000000      /* Select interpolation ROM 3                           */
430 #define CCCA_INTERPROM_4        0x08000000      /* Select interpolation ROM 4                           */
431 #define CCCA_INTERPROM_5        0x0a000000      /* Select interpolation ROM 5                           */
432 #define CCCA_INTERPROM_6        0x0c000000      /* Select interpolation ROM 6                           */
433 #define CCCA_INTERPROM_7        0x0e000000      /* Select interpolation ROM 7                           */
434 #define CCCA_8BITSELECT         0x01000000      /* 1 = Sound memory for this channel uses 8-bit samples */
435 #define CCCA_CURRADDR_MASK      0x00ffffff      /* Current address of the selected channel              */
436 #define CCCA_CURRADDR           0x18000008
437
438 #define CCR                     0x09            /* Cache control register                               */
439 #define CCR_CACHEINVALIDSIZE    0x07190009
440 #define CCR_CACHEINVALIDSIZE_MASK       0xfe000000      /* Number of invalid samples cache for this channel     */
441 #define CCR_CACHELOOPFLAG       0x01000000      /* 1 = Cache has a loop service pending                 */
442 #define CCR_INTERLEAVEDSAMPLES  0x00800000      /* 1 = A cache service will fetch interleaved samples   */
443 #define CCR_WORDSIZEDSAMPLES    0x00400000      /* 1 = A cache service will fetch word sized samples    */
444 #define CCR_READADDRESS         0x06100009
445 #define CCR_READADDRESS_MASK    0x003f0000      /* Location of cache just beyond current cache service  */
446 #define CCR_LOOPINVALSIZE       0x0000fe00      /* Number of invalid samples in cache prior to loop     */
447                                                 /* NOTE: This is valid only if CACHELOOPFLAG is set     */
448 #define CCR_LOOPFLAG            0x00000100      /* Set for a single sample period when a loop occurs    */
449 #define CCR_CACHELOOPADDRHI     0x000000ff      /* DSL_LOOPSTARTADDR's hi byte if CACHELOOPFLAG is set  */
450
451 #define CLP                     0x0a            /* Cache loop register (valid if CCR_CACHELOOPFLAG = 1) */
452                                                 /* NOTE: This register is normally not used             */
453 #define CLP_CACHELOOPADDR       0x0000ffff      /* Cache loop address (DSL_LOOPSTARTADDR [0..15])       */
454
455 #define FXRT                    0x0b            /* Effects send routing register                        */
456                                                 /* NOTE: It is illegal to assign the same routing to    */
457                                                 /* two effects sends.                                   */
458 #define FXRT_CHANNELA           0x000f0000      /* Effects send bus number for channel's effects send A */
459 #define FXRT_CHANNELB           0x00f00000      /* Effects send bus number for channel's effects send B */
460 #define FXRT_CHANNELC           0x0f000000      /* Effects send bus number for channel's effects send C */
461 #define FXRT_CHANNELD           0xf0000000      /* Effects send bus number for channel's effects send D */
462
463 #define A_HR                    0x0b    /* High Resolution. 24bit playback from host to DSP. */
464 #define MAPA                    0x0c            /* Cache map A                                          */
465
466 #define MAPB                    0x0d            /* Cache map B                                          */
467
468 #define MAP_PTE_MASK            0xffffe000      /* The 19 MSBs of the PTE indexed by the PTI            */
469 #define MAP_PTI_MASK            0x00001fff      /* The 13 bit index to one of the 8192 PTE dwords       */
470
471 /* 0x0e, 0x0f: Not used */
472
473 #define ENVVOL                  0x10            /* Volume envelope register                             */
474 #define ENVVOL_MASK             0x0000ffff      /* Current value of volume envelope state variable      */  
475                                                 /* 0x8000-n == 666*n usec delay                         */
476
477 #define ATKHLDV                 0x11            /* Volume envelope hold and attack register             */
478 #define ATKHLDV_PHASE0          0x00008000      /* 0 = Begin attack phase                               */
479 #define ATKHLDV_HOLDTIME_MASK   0x00007f00      /* Envelope hold time (127-n == n*88.2msec)             */
480 #define ATKHLDV_ATTACKTIME_MASK 0x0000007f      /* Envelope attack time, log encoded                    */
481                                                 /* 0 = infinite, 1 = 10.9msec, ... 0x7f = 5.5msec       */
482
483 #define DCYSUSV                 0x12            /* Volume envelope sustain and decay register           */
484 #define DCYSUSV_PHASE1_MASK     0x00008000      /* 0 = Begin attack phase, 1 = begin release phase      */
485 #define DCYSUSV_SUSTAINLEVEL_MASK 0x00007f00    /* 127 = full, 0 = off, 0.75dB increments               */
486 #define DCYSUSV_CHANNELENABLE_MASK 0x00000080   /* 1 = Inhibit envelope engine from writing values in   */
487                                                 /* this channel and from writing to pitch, filter and   */
488                                                 /* volume targets.                                      */
489 #define DCYSUSV_DECAYTIME_MASK  0x0000007f      /* Volume envelope decay time, log encoded              */
490                                                 /* 0 = 43.7msec, 1 = 21.8msec, 0x7f = 22msec            */
491
492 #define LFOVAL1                 0x13            /* Modulation LFO value                                 */
493 #define LFOVAL_MASK             0x0000ffff      /* Current value of modulation LFO state variable       */
494                                                 /* 0x8000-n == 666*n usec delay                         */
495
496 #define ENVVAL                  0x14            /* Modulation envelope register                         */
497 #define ENVVAL_MASK             0x0000ffff      /* Current value of modulation envelope state variable  */
498                                                 /* 0x8000-n == 666*n usec delay                         */
499
500 #define ATKHLDM                 0x15            /* Modulation envelope hold and attack register         */
501 #define ATKHLDM_PHASE0          0x00008000      /* 0 = Begin attack phase                               */
502 #define ATKHLDM_HOLDTIME        0x00007f00      /* Envelope hold time (127-n == n*42msec)               */
503 #define ATKHLDM_ATTACKTIME      0x0000007f      /* Envelope attack time, log encoded                    */
504                                                 /* 0 = infinite, 1 = 11msec, ... 0x7f = 5.5msec         */
505
506 #define DCYSUSM                 0x16            /* Modulation envelope decay and sustain register       */
507 #define DCYSUSM_PHASE1_MASK     0x00008000      /* 0 = Begin attack phase, 1 = begin release phase      */
508 #define DCYSUSM_SUSTAINLEVEL_MASK 0x00007f00    /* 127 = full, 0 = off, 0.75dB increments               */
509 #define DCYSUSM_DECAYTIME_MASK  0x0000007f      /* Envelope decay time, log encoded                     */
510                                                 /* 0 = 43.7msec, 1 = 21.8msec, 0x7f = 22msec            */
511
512 #define LFOVAL2                 0x17            /* Vibrato LFO register                                 */
513 #define LFOVAL2_MASK            0x0000ffff      /* Current value of vibrato LFO state variable          */
514                                                 /* 0x8000-n == 666*n usec delay                         */
515
516 #define IP                      0x18            /* Initial pitch register                               */
517 #define IP_MASK                 0x0000ffff      /* Exponential initial pitch shift                      */
518                                                 /* 4 bits of octave, 12 bits of fractional octave       */
519 #define IP_UNITY                0x0000e000      /* Unity pitch shift                                    */
520
521 #define IFATN                   0x19            /* Initial filter cutoff and attenuation register       */
522 #define IFATN_FILTERCUTOFF_MASK 0x0000ff00      /* Initial filter cutoff frequency in exponential units */
523                                                 /* 6 most significant bits are semitones                */
524                                                 /* 2 least significant bits are fractions               */
525 #define IFATN_FILTERCUTOFF      0x08080019
526 #define IFATN_ATTENUATION_MASK  0x000000ff      /* Initial attenuation in 0.375dB steps                 */
527 #define IFATN_ATTENUATION       0x08000019
528
529
530 #define PEFE                    0x1a            /* Pitch envelope and filter envelope amount register   */
531 #define PEFE_PITCHAMOUNT_MASK   0x0000ff00      /* Pitch envlope amount                                 */
532                                                 /* Signed 2's complement, +/- one octave peak extremes  */
533 #define PEFE_PITCHAMOUNT        0x0808001a
534 #define PEFE_FILTERAMOUNT_MASK  0x000000ff      /* Filter envlope amount                                */
535                                                 /* Signed 2's complement, +/- six octaves peak extremes */
536 #define PEFE_FILTERAMOUNT       0x0800001a
537 #define FMMOD                   0x1b            /* Vibrato/filter modulation from LFO register          */
538 #define FMMOD_MODVIBRATO        0x0000ff00      /* Vibrato LFO modulation depth                         */
539                                                 /* Signed 2's complement, +/- one octave extremes       */
540 #define FMMOD_MOFILTER          0x000000ff      /* Filter LFO modulation depth                          */
541                                                 /* Signed 2's complement, +/- three octave extremes     */
542
543
544 #define TREMFRQ                 0x1c            /* Tremolo amount and modulation LFO frequency register */
545 #define TREMFRQ_DEPTH           0x0000ff00      /* Tremolo depth                                        */
546                                                 /* Signed 2's complement, with +/- 12dB extremes        */
547
548 #define TREMFRQ_FREQUENCY       0x000000ff      /* Tremolo LFO frequency                                */
549                                                 /* ??Hz steps, maximum of ?? Hz.                        */
550 #define FM2FRQ2                 0x1d            /* Vibrato amount and vibrato LFO frequency register    */
551 #define FM2FRQ2_DEPTH           0x0000ff00      /* Vibrato LFO vibrato depth                            */
552                                                 /* Signed 2's complement, +/- one octave extremes       */
553 #define FM2FRQ2_FREQUENCY       0x000000ff      /* Vibrato LFO frequency                                */
554                                                 /* 0.039Hz steps, maximum of 9.85 Hz.                   */
555
556 #define TEMPENV                 0x1e            /* Tempory envelope register                            */
557 #define TEMPENV_MASK            0x0000ffff      /* 16-bit value                                         */
558                                                 /* NOTE: All channels contain internal variables; do    */
559                                                 /* not write to these locations.                        */
560
561 /* 0x1f: not used */
562
563 #define CD0                     0x20            /* Cache data 0 register                                */
564 #define CD1                     0x21            /* Cache data 1 register                                */
565 #define CD2                     0x22            /* Cache data 2 register                                */
566 #define CD3                     0x23            /* Cache data 3 register                                */
567 #define CD4                     0x24            /* Cache data 4 register                                */
568 #define CD5                     0x25            /* Cache data 5 register                                */
569 #define CD6                     0x26            /* Cache data 6 register                                */
570 #define CD7                     0x27            /* Cache data 7 register                                */
571 #define CD8                     0x28            /* Cache data 8 register                                */
572 #define CD9                     0x29            /* Cache data 9 register                                */
573 #define CDA                     0x2a            /* Cache data A register                                */
574 #define CDB                     0x2b            /* Cache data B register                                */
575 #define CDC                     0x2c            /* Cache data C register                                */
576 #define CDD                     0x2d            /* Cache data D register                                */
577 #define CDE                     0x2e            /* Cache data E register                                */
578 #define CDF                     0x2f            /* Cache data F register                                */
579
580 /* 0x30-3f seem to be the same as 0x20-2f */
581
582 #define PTB                     0x40            /* Page table base register                             */
583 #define PTB_MASK                0xfffff000      /* Physical address of the page table in host memory    */
584
585 #define TCB                     0x41            /* Tank cache base register                             */
586 #define TCB_MASK                0xfffff000      /* Physical address of the bottom of host based TRAM    */
587
588 #define ADCCR                   0x42            /* ADC sample rate/stereo control register              */
589 #define ADCCR_RCHANENABLE       0x00000010      /* Enables right channel for writing to the host        */
590 #define ADCCR_LCHANENABLE       0x00000008      /* Enables left channel for writing to the host         */
591                                                 /* NOTE: To guarantee phase coherency, both channels    */
592                                                 /* must be disabled prior to enabling both channels.    */
593 #define A_ADCCR_RCHANENABLE     0x00000020
594 #define A_ADCCR_LCHANENABLE     0x00000010
595
596 #define A_ADCCR_SAMPLERATE_MASK 0x0000000F      /* Audigy sample rate convertor output rate             */
597 #define ADCCR_SAMPLERATE_MASK   0x00000007      /* Sample rate convertor output rate                    */
598 #define ADCCR_SAMPLERATE_48     0x00000000      /* 48kHz sample rate                                    */
599 #define ADCCR_SAMPLERATE_44     0x00000001      /* 44.1kHz sample rate                                  */
600 #define ADCCR_SAMPLERATE_32     0x00000002      /* 32kHz sample rate                                    */
601 #define ADCCR_SAMPLERATE_24     0x00000003      /* 24kHz sample rate                                    */
602 #define ADCCR_SAMPLERATE_22     0x00000004      /* 22.05kHz sample rate                                 */
603 #define ADCCR_SAMPLERATE_16     0x00000005      /* 16kHz sample rate                                    */
604 #define ADCCR_SAMPLERATE_11     0x00000006      /* 11.025kHz sample rate                                */
605 #define ADCCR_SAMPLERATE_8      0x00000007      /* 8kHz sample rate                                     */
606 #define A_ADCCR_SAMPLERATE_12   0x00000006      /* 12kHz sample rate                                    */
607 #define A_ADCCR_SAMPLERATE_11   0x00000007      /* 11.025kHz sample rate                                */
608 #define A_ADCCR_SAMPLERATE_8    0x00000008      /* 8kHz sample rate                                     */
609
610 #define FXWC                    0x43            /* FX output write channels register                    */
611                                                 /* When set, each bit enables the writing of the        */
612                                                 /* corresponding FX output channel (internal registers  */
613                                                 /* 0x20-0x3f) to host memory.  This mode of recording   */
614                                                 /* is 16bit, 48KHz only. All 32 channels can be enabled */
615                                                 /* simultaneously.                                      */
616
617 #define FXWC_DEFAULTROUTE_C     (1<<0)          /* left emu out? */
618 #define FXWC_DEFAULTROUTE_B     (1<<1)          /* right emu out? */
619 #define FXWC_DEFAULTROUTE_A     (1<<12)
620 #define FXWC_DEFAULTROUTE_D     (1<<13)
621 #define FXWC_ADCLEFT            (1<<18)
622 #define FXWC_CDROMSPDIFLEFT     (1<<18)
623 #define FXWC_ADCRIGHT           (1<<19)
624 #define FXWC_CDROMSPDIFRIGHT    (1<<19)
625 #define FXWC_MIC                (1<<20)
626 #define FXWC_ZOOMLEFT           (1<<20)
627 #define FXWC_ZOOMRIGHT          (1<<21)
628 #define FXWC_SPDIFLEFT          (1<<22)         /* 0x00400000 */
629 #define FXWC_SPDIFRIGHT         (1<<23)         /* 0x00800000 */
630
631 #define A_TBLSZ                 0x43    /* Effects Tank Internal Table Size. Only low byte or register used */
632
633 #define TCBS                    0x44            /* Tank cache buffer size register                      */
634 #define TCBS_MASK               0x00000007      /* Tank cache buffer size field                         */
635 #define TCBS_BUFFSIZE_16K       0x00000000
636 #define TCBS_BUFFSIZE_32K       0x00000001
637 #define TCBS_BUFFSIZE_64K       0x00000002
638 #define TCBS_BUFFSIZE_128K      0x00000003
639 #define TCBS_BUFFSIZE_256K      0x00000004
640 #define TCBS_BUFFSIZE_512K      0x00000005
641 #define TCBS_BUFFSIZE_1024K     0x00000006
642 #define TCBS_BUFFSIZE_2048K     0x00000007
643
644 #define MICBA                   0x45            /* AC97 microphone buffer address register              */
645 #define MICBA_MASK              0xfffff000      /* 20 bit base address                                  */
646
647 #define ADCBA                   0x46            /* ADC buffer address register                          */
648 #define ADCBA_MASK              0xfffff000      /* 20 bit base address                                  */
649
650 #define FXBA                    0x47            /* FX Buffer Address */
651 #define FXBA_MASK               0xfffff000      /* 20 bit base address                                  */
652
653 #define A_HWM                   0x48    /* High PCI Water Mark - word access, defaults to 3f */
654
655 #define MICBS                   0x49            /* Microphone buffer size register                      */
656
657 #define ADCBS                   0x4a            /* ADC buffer size register                             */
658
659 #define FXBS                    0x4b            /* FX buffer size register                              */
660
661 /* register: 0x4c..4f: ffff-ffff current amounts, per-channel */
662
663 /* The following mask values define the size of the ADC, MIX and FX buffers in bytes */
664 #define ADCBS_BUFSIZE_NONE      0x00000000
665 #define ADCBS_BUFSIZE_384       0x00000001
666 #define ADCBS_BUFSIZE_448       0x00000002
667 #define ADCBS_BUFSIZE_512       0x00000003
668 #define ADCBS_BUFSIZE_640       0x00000004
669 #define ADCBS_BUFSIZE_768       0x00000005
670 #define ADCBS_BUFSIZE_896       0x00000006
671 #define ADCBS_BUFSIZE_1024      0x00000007
672 #define ADCBS_BUFSIZE_1280      0x00000008
673 #define ADCBS_BUFSIZE_1536      0x00000009
674 #define ADCBS_BUFSIZE_1792      0x0000000a
675 #define ADCBS_BUFSIZE_2048      0x0000000b
676 #define ADCBS_BUFSIZE_2560      0x0000000c
677 #define ADCBS_BUFSIZE_3072      0x0000000d
678 #define ADCBS_BUFSIZE_3584      0x0000000e
679 #define ADCBS_BUFSIZE_4096      0x0000000f
680 #define ADCBS_BUFSIZE_5120      0x00000010
681 #define ADCBS_BUFSIZE_6144      0x00000011
682 #define ADCBS_BUFSIZE_7168      0x00000012
683 #define ADCBS_BUFSIZE_8192      0x00000013
684 #define ADCBS_BUFSIZE_10240     0x00000014
685 #define ADCBS_BUFSIZE_12288     0x00000015
686 #define ADCBS_BUFSIZE_14366     0x00000016
687 #define ADCBS_BUFSIZE_16384     0x00000017
688 #define ADCBS_BUFSIZE_20480     0x00000018
689 #define ADCBS_BUFSIZE_24576     0x00000019
690 #define ADCBS_BUFSIZE_28672     0x0000001a
691 #define ADCBS_BUFSIZE_32768     0x0000001b
692 #define ADCBS_BUFSIZE_40960     0x0000001c
693 #define ADCBS_BUFSIZE_49152     0x0000001d
694 #define ADCBS_BUFSIZE_57344     0x0000001e
695 #define ADCBS_BUFSIZE_65536     0x0000001f
696
697 /* Current Send B, A Amounts */
698 #define A_CSBA                  0x4c
699
700 /* Current Send D, C Amounts */
701 #define A_CSDC                  0x4d
702
703 /* Current Send F, E Amounts */
704 #define A_CSFE                  0x4e
705
706 /* Current Send H, G Amounts */
707 #define A_CSHG                  0x4f
708
709
710 #define CDCS                    0x50            /* CD-ROM digital channel status register       */
711
712 #define GPSCS                   0x51            /* General Purpose SPDIF channel status register*/
713
714 #define DBG                     0x52            /* DO NOT PROGRAM THIS REGISTER!!! MAY DESTROY CHIP */
715
716 /* S/PDIF Input C Channel Status */
717 #define A_SPSC                  0x52
718
719 #define REG53                   0x53            /* DO NOT PROGRAM THIS REGISTER!!! MAY DESTROY CHIP */
720
721 #define A_DBG                    0x53
722 #define A_DBG_SINGLE_STEP        0x00020000     /* Set to zero to start dsp */
723 #define A_DBG_ZC                 0x40000000     /* zero tram counter */
724 #define A_DBG_STEP_ADDR          0x000003ff
725 #define A_DBG_SATURATION_OCCURED 0x20000000
726 #define A_DBG_SATURATION_ADDR    0x0ffc0000
727
728 // NOTE: 0x54,55,56: 64-bit
729 #define SPCS0                   0x54            /* SPDIF output Channel Status 0 register       */
730
731 #define SPCS1                   0x55            /* SPDIF output Channel Status 1 register       */
732
733 #define SPCS2                   0x56            /* SPDIF output Channel Status 2 register       */
734
735 #define SPCS_CLKACCYMASK        0x30000000      /* Clock accuracy                               */
736 #define SPCS_CLKACCY_1000PPM    0x00000000      /* 1000 parts per million                       */
737 #define SPCS_CLKACCY_50PPM      0x10000000      /* 50 parts per million                         */
738 #define SPCS_CLKACCY_VARIABLE   0x20000000      /* Variable accuracy                            */
739 #define SPCS_SAMPLERATEMASK     0x0f000000      /* Sample rate                                  */
740 #define SPCS_SAMPLERATE_44      0x00000000      /* 44.1kHz sample rate                          */
741 #define SPCS_SAMPLERATE_48      0x02000000      /* 48kHz sample rate                            */
742 #define SPCS_SAMPLERATE_32      0x03000000      /* 32kHz sample rate                            */
743 #define SPCS_CHANNELNUMMASK     0x00f00000      /* Channel number                               */
744 #define SPCS_CHANNELNUM_UNSPEC  0x00000000      /* Unspecified channel number                   */
745 #define SPCS_CHANNELNUM_LEFT    0x00100000      /* Left channel                                 */
746 #define SPCS_CHANNELNUM_RIGHT   0x00200000      /* Right channel                                */
747 #define SPCS_SOURCENUMMASK      0x000f0000      /* Source number                                */
748 #define SPCS_SOURCENUM_UNSPEC   0x00000000      /* Unspecified source number                    */
749 #define SPCS_GENERATIONSTATUS   0x00008000      /* Originality flag (see IEC-958 spec)          */
750 #define SPCS_CATEGORYCODEMASK   0x00007f00      /* Category code (see IEC-958 spec)             */
751 #define SPCS_MODEMASK           0x000000c0      /* Mode (see IEC-958 spec)                      */
752 #define SPCS_EMPHASISMASK       0x00000038      /* Emphasis                                     */
753 #define SPCS_EMPHASIS_NONE      0x00000000      /* No emphasis                                  */
754 #define SPCS_EMPHASIS_50_15     0x00000008      /* 50/15 usec 2 channel                         */
755 #define SPCS_COPYRIGHT          0x00000004      /* Copyright asserted flag -- do not modify     */
756 #define SPCS_NOTAUDIODATA       0x00000002      /* 0 = Digital audio, 1 = not audio             */
757 #define SPCS_PROFESSIONAL       0x00000001      /* 0 = Consumer (IEC-958), 1 = pro (AES3-1992)  */
758
759 /* 0x57: Not used */
760
761 /* The 32-bit CLIx and SOLx registers all have one bit per channel control/status               */
762 #define CLIEL                   0x58            /* Channel loop interrupt enable low register   */
763
764 #define CLIEH                   0x59            /* Channel loop interrupt enable high register  */
765
766 #define CLIPL                   0x5a            /* Channel loop interrupt pending low register  */
767
768 #define CLIPH                   0x5b            /* Channel loop interrupt pending high register */
769
770 #define SOLEL                   0x5c            /* Stop on loop enable low register             */
771
772 #define SOLEH                   0x5d            /* Stop on loop enable high register            */
773
774 #define SPBYPASS                0x5e            /* SPDIF BYPASS mode register                   */
775 #define SPBYPASS_SPDIF0_MASK    0x00000003      /* SPDIF 0 bypass mode                          */
776 #define SPBYPASS_SPDIF1_MASK    0x0000000c      /* SPDIF 1 bypass mode                          */
777 /* bypass mode: 0 - DSP; 1 - SPDIF A, 2 - SPDIF B, 3 - SPDIF C                                  */
778 #define SPBYPASS_FORMAT         0x00000f00      /* If 1, SPDIF XX uses 24 bit, if 0 - 20 bit    */
779
780 #define AC97SLOT                0x5f            /* additional AC97 slots enable bits            */
781 #define AC97SLOT_REAR_RIGHT     0x01            /* Rear left */
782 #define AC97SLOT_REAR_LEFT      0x02            /* Rear right */
783 #define AC97SLOT_CNTR           0x10            /* Center enable */
784 #define AC97SLOT_LFE            0x20            /* LFE enable */
785
786 /* PCB Revision */
787 #define A_PCB                   0x5f
788
789 // NOTE: 0x60,61,62: 64-bit
790 #define CDSRCS                  0x60            /* CD-ROM Sample Rate Converter status register */
791
792 #define GPSRCS                  0x61            /* General Purpose SPDIF sample rate cvt status */
793
794 #define ZVSRCS                  0x62            /* ZVideo sample rate converter status          */
795                                                 /* NOTE: This one has no SPDIFLOCKED field      */
796                                                 /* Assumes sample lock                          */
797
798 /* These three bitfields apply to CDSRCS, GPSRCS, and (except as noted) ZVSRCS.                 */
799 #define SRCS_SPDIFVALID         0x04000000      /* SPDIF stream valid                           */
800 #define SRCS_SPDIFLOCKED        0x02000000      /* SPDIF stream locked                          */
801 #define SRCS_RATELOCKED         0x01000000      /* Sample rate locked                           */
802 #define SRCS_ESTSAMPLERATE      0x0007ffff      /* Do not modify this field.                    */
803
804 /* Note that these values can vary +/- by a small amount                                        */
805 #define SRCS_SPDIFRATE_44       0x0003acd9
806 #define SRCS_SPDIFRATE_48       0x00040000
807 #define SRCS_SPDIFRATE_96       0x00080000
808
809 #define MICIDX                  0x63            /* Microphone recording buffer index register   */
810 #define MICIDX_MASK             0x0000ffff      /* 16-bit value                                 */
811 #define MICIDX_IDX              0x10000063
812
813 #define ADCIDX                  0x64            /* ADC recording buffer index register          */
814 #define ADCIDX_MASK             0x0000ffff      /* 16 bit index field                           */
815 #define ADCIDX_IDX              0x10000064
816
817 #define A_ADCIDX                0x63
818 #define A_ADCIDX_IDX            0x10000063
819
820 #define A_MICIDX                0x64
821 #define A_MICIDX_IDX            0x10000064
822
823 #define FXIDX                   0x65            /* FX recording buffer index register           */
824 #define FXIDX_MASK              0x0000ffff      /* 16-bit value                                 */
825 #define FXIDX_IDX               0x10000065
826
827 /* The 32-bit HLIx and HLIPx registers all have one bit per channel control/status                      */
828 #define HLIEL                   0x66            /* Channel half loop interrupt enable low register      */
829
830 #define HLIEH                   0x67            /* Channel half loop interrupt enable high register     */
831
832 #define HLIPL                   0x68            /* Channel half loop interrupt pending low register     */
833
834 #define HLIPH                   0x69            /* Channel half loop interrupt pending high register    */
835
836 /* S/PDIF Host Record Index (bypasses SRC) */
837 #define A_SPRI                  0x6a
838 /* S/PDIF Host Record Address */
839 #define A_SPRA                  0x6b
840 /* S/PDIF Host Record Control */
841 #define A_SPRC                  0x6c
842 /* Delayed Interrupt Counter & Enable */
843 #define A_DICE                  0x6d
844 /* Tank Table Base */
845 #define A_TTB                   0x6e
846 /* Tank Delay Offset */
847 #define A_TDOF                  0x6f
848
849 /* This is the MPU port on the card (via the game port)                                         */
850 #define A_MUDATA1               0x70
851 #define A_MUCMD1                0x71
852 #define A_MUSTAT1               A_MUCMD1
853
854 /* This is the MPU port on the Audigy Drive                                                     */
855 #define A_MUDATA2               0x72
856 #define A_MUCMD2                0x73
857 #define A_MUSTAT2               A_MUCMD2        
858
859 /* The next two are the Audigy equivalent of FXWC                                               */
860 /* the Audigy can record any output (16bit, 48kHz, up to 64 channel simultaneously)             */
861 /* Each bit selects a channel for recording */
862 #define A_FXWC1                 0x74            /* Selects 0x7f-0x60 for FX recording           */
863 #define A_FXWC2                 0x75            /* Selects 0x9f-0x80 for FX recording           */
864
865 /* Extended Hardware Control */
866 #define A_SPDIF_SAMPLERATE      0x76            /* Set the sample rate of SPDIF output          */
867 #define A_SAMPLE_RATE           0x76            /* Various sample rate settings. */
868 #define A_SAMPLE_RATE_NOT_USED  0x0ffc111e      /* Bits that are not used and cannot be set.    */
869 #define A_SAMPLE_RATE_UNKNOWN   0xf0030001      /* Bits that can be set, but have unknown use.  */
870 #define A_SPDIF_RATE_MASK       0x000000e0      /* Any other values for rates, just use 48000   */
871 #define A_SPDIF_48000           0x00000000
872 #define A_SPDIF_192000          0x00000020
873 #define A_SPDIF_96000           0x00000040
874 #define A_SPDIF_44100           0x00000080
875
876 #define A_I2S_CAPTURE_RATE_MASK 0x00000e00      /* This sets the capture PCM rate, but it is    */
877 #define A_I2S_CAPTURE_48000     0x00000000      /* unclear if this sets the ADC rate as well.   */
878 #define A_I2S_CAPTURE_192000    0x00000200
879 #define A_I2S_CAPTURE_96000     0x00000400
880 #define A_I2S_CAPTURE_44100     0x00000800
881
882 #define A_PCM_RATE_MASK         0x0000e000      /* This sets the playback PCM rate on the P16V  */
883 #define A_PCM_48000             0x00000000
884 #define A_PCM_192000            0x00002000
885 #define A_PCM_96000             0x00004000
886 #define A_PCM_44100             0x00008000
887
888 /* I2S0 Sample Rate Tracker Status */
889 #define A_SRT3                  0x77
890
891 /* I2S1 Sample Rate Tracker Status */
892 #define A_SRT4                  0x78
893
894 /* I2S2 Sample Rate Tracker Status */
895 #define A_SRT5                  0x79
896 /* - default to 0x01080000 on my audigy 2 ZS --rlrevell */
897
898 /* Tank Table DMA Address */
899 #define A_TTDA                  0x7a
900 /* Tank Table DMA Data */
901 #define A_TTDD                  0x7b
902
903 #define A_FXRT2                 0x7c
904 #define A_FXRT_CHANNELE         0x0000003f      /* Effects send bus number for channel's effects send E */
905 #define A_FXRT_CHANNELF         0x00003f00      /* Effects send bus number for channel's effects send F */
906 #define A_FXRT_CHANNELG         0x003f0000      /* Effects send bus number for channel's effects send G */
907 #define A_FXRT_CHANNELH         0x3f000000      /* Effects send bus number for channel's effects send H */
908
909 #define A_SENDAMOUNTS           0x7d
910 #define A_FXSENDAMOUNT_E_MASK   0xFF000000
911 #define A_FXSENDAMOUNT_F_MASK   0x00FF0000
912 #define A_FXSENDAMOUNT_G_MASK   0x0000FF00
913 #define A_FXSENDAMOUNT_H_MASK   0x000000FF
914 /* 0x7c, 0x7e "high bit is used for filtering" */
915  
916 /* The send amounts for this one are the same as used with the emu10k1 */
917 #define A_FXRT1                 0x7e
918 #define A_FXRT_CHANNELA         0x0000003f
919 #define A_FXRT_CHANNELB         0x00003f00
920 #define A_FXRT_CHANNELC         0x003f0000
921 #define A_FXRT_CHANNELD         0x3f000000
922
923 /* 0x7f: Not used */
924 /* Each FX general purpose register is 32 bits in length, all bits are used                     */
925 #define FXGPREGBASE             0x100           /* FX general purpose registers base            */
926 #define A_FXGPREGBASE           0x400           /* Audigy GPRs, 0x400 to 0x5ff                  */
927
928 #define A_TANKMEMCTLREGBASE     0x100           /* Tank memory control registers base - only for Audigy */
929 #define A_TANKMEMCTLREG_MASK    0x1f            /* only 5 bits used - only for Audigy */
930
931 /* Tank audio data is logarithmically compressed down to 16 bits before writing to TRAM and is  */
932 /* decompressed back to 20 bits on a read.  There are a total of 160 locations, the last 32     */
933 /* locations are for external TRAM.                                                             */
934 #define TANKMEMDATAREGBASE      0x200           /* Tank memory data registers base              */
935 #define TANKMEMDATAREG_MASK     0x000fffff      /* 20 bit tank audio data field                 */
936
937 /* Combined address field and memory opcode or flag field.  160 locations, last 32 are external */
938 #define TANKMEMADDRREGBASE      0x300           /* Tank memory address registers base           */
939 #define TANKMEMADDRREG_ADDR_MASK 0x000fffff     /* 20 bit tank address field                    */
940 #define TANKMEMADDRREG_CLEAR    0x00800000      /* Clear tank memory                            */
941 #define TANKMEMADDRREG_ALIGN    0x00400000      /* Align read or write relative to tank access  */
942 #define TANKMEMADDRREG_WRITE    0x00200000      /* Write to tank memory                         */
943 #define TANKMEMADDRREG_READ     0x00100000      /* Read from tank memory                        */
944
945 #define MICROCODEBASE           0x400           /* Microcode data base address                  */
946
947 /* Each DSP microcode instruction is mapped into 2 doublewords                                  */
948 /* NOTE: When writing, always write the LO doubleword first.  Reads can be in either order.     */
949 #define LOWORD_OPX_MASK         0x000ffc00      /* Instruction operand X                        */
950 #define LOWORD_OPY_MASK         0x000003ff      /* Instruction operand Y                        */
951 #define HIWORD_OPCODE_MASK      0x00f00000      /* Instruction opcode                           */
952 #define HIWORD_RESULT_MASK      0x000ffc00      /* Instruction result                           */
953 #define HIWORD_OPA_MASK         0x000003ff      /* Instruction operand A                        */
954
955
956 /* Audigy Soundcard have a different instruction format */
957 #define A_MICROCODEBASE         0x600
958 #define A_LOWORD_OPY_MASK       0x000007ff
959 #define A_LOWORD_OPX_MASK       0x007ff000
960 #define A_HIWORD_OPCODE_MASK    0x0f000000
961 #define A_HIWORD_RESULT_MASK    0x007ff000
962 #define A_HIWORD_OPA_MASK       0x000007ff
963
964 /************************************************************************************************/
965 /* EMU1010m HANA FPGA registers                                                                 */
966 /************************************************************************************************/
967 #define EMU_HANA_DESTHI         0x00    /* 0000xxx  3 bits Link Destination */
968 #define EMU_HANA_DESTLO         0x01    /* 00xxxxx  5 bits */
969 #define EMU_HANA_SRCHI          0x02    /* 0000xxx  3 bits Link Source */
970 #define EMU_HANA_SRCLO          0x03    /* 00xxxxx  5 bits */
971 #define EMU_HANA_DOCK_PWR       0x04    /* 000000x  1 bits Audio Dock power */
972 #define EMU_HANA_DOCK_PWR_ON            0x01 /* Audio Dock power on */
973 #define EMU_HANA_WCLOCK         0x05    /* 0000xxx  3 bits Word Clock source select  */
974                                         /* Must be written after power on to reset DLL */
975                                         /* One is unable to detect the Audio dock without this */
976 #define EMU_HANA_WCLOCK_SRC_MASK        0x07
977 #define EMU_HANA_WCLOCK_INT_48K         0x00
978 #define EMU_HANA_WCLOCK_INT_44_1K       0x01
979 #define EMU_HANA_WCLOCK_HANA_SPDIF_IN   0x02
980 #define EMU_HANA_WCLOCK_HANA_ADAT_IN    0x03
981 #define EMU_HANA_WCLOCK_SYNC_BNCN       0x04
982 #define EMU_HANA_WCLOCK_2ND_HANA        0x05
983 #define EMU_HANA_WCLOCK_SRC_RESERVED    0x06
984 #define EMU_HANA_WCLOCK_OFF             0x07 /* For testing, forces fallback to DEFCLOCK */
985 #define EMU_HANA_WCLOCK_MULT_MASK       0x18
986 #define EMU_HANA_WCLOCK_1X              0x00
987 #define EMU_HANA_WCLOCK_2X              0x08
988 #define EMU_HANA_WCLOCK_4X              0x10
989 #define EMU_HANA_WCLOCK_MULT_RESERVED   0x18
990
991 #define EMU_HANA_DEFCLOCK       0x06    /* 000000x  1 bits Default Word Clock  */
992 #define EMU_HANA_DEFCLOCK_48K           0x00
993 #define EMU_HANA_DEFCLOCK_44_1K         0x01
994
995 #define EMU_HANA_UNMUTE         0x07    /* 000000x  1 bits Mute all audio outputs  */
996 #define EMU_MUTE                        0x00
997 #define EMU_UNMUTE                      0x01
998
999 #define EMU_HANA_FPGA_CONFIG    0x08    /* 00000xx  2 bits Config control of FPGAs  */
1000 #define EMU_HANA_FPGA_CONFIG_AUDIODOCK  0x01 /* Set in order to program FPGA on Audio Dock */
1001 #define EMU_HANA_FPGA_CONFIG_HANA       0x02 /* Set in order to program FPGA on Hana */
1002
1003 #define EMU_HANA_IRQ_ENABLE     0x09    /* 000xxxx  4 bits IRQ Enable  */
1004 #define EMU_HANA_IRQ_WCLK_CHANGED       0x01
1005 #define EMU_HANA_IRQ_ADAT               0x02
1006 #define EMU_HANA_IRQ_DOCK               0x04
1007 #define EMU_HANA_IRQ_DOCK_LOST          0x08
1008
1009 #define EMU_HANA_SPDIF_MODE     0x0a    /* 00xxxxx  5 bits SPDIF MODE  */
1010 #define EMU_HANA_SPDIF_MODE_TX_COMSUMER 0x00
1011 #define EMU_HANA_SPDIF_MODE_TX_PRO      0x01
1012 #define EMU_HANA_SPDIF_MODE_TX_NOCOPY   0x02
1013 #define EMU_HANA_SPDIF_MODE_RX_COMSUMER 0x00
1014 #define EMU_HANA_SPDIF_MODE_RX_PRO      0x04
1015 #define EMU_HANA_SPDIF_MODE_RX_NOCOPY   0x08
1016 #define EMU_HANA_SPDIF_MODE_RX_INVALID  0x10
1017
1018 #define EMU_HANA_OPTICAL_TYPE   0x0b    /* 00000xx  2 bits ADAT or SPDIF in/out  */
1019 #define EMU_HANA_OPTICAL_IN_SPDIF       0x00
1020 #define EMU_HANA_OPTICAL_IN_ADAT        0x01
1021 #define EMU_HANA_OPTICAL_OUT_SPDIF      0x00
1022 #define EMU_HANA_OPTICAL_OUT_ADAT       0x02
1023
1024 #define EMU_HANA_MIDI_IN                0x0c    /* 000000x  1 bit  Control MIDI  */
1025 #define EMU_HANA_MIDI_IN_FROM_HAMOA     0x00 /* HAMOA MIDI in to Alice 2 MIDI B */
1026 #define EMU_HANA_MIDI_IN_FROM_DOCK      0x01 /* Audio Dock MIDI in to Alice 2 MIDI B */
1027
1028 #define EMU_HANA_DOCK_LEDS_1    0x0d    /* 000xxxx  4 bit  Audio Dock LEDs  */
1029 #define EMU_HANA_DOCK_LEDS_1_MIDI1      0x01    /* MIDI 1 LED on */
1030 #define EMU_HANA_DOCK_LEDS_1_MIDI2      0x02    /* MIDI 2 LED on */
1031 #define EMU_HANA_DOCK_LEDS_1_SMPTE_IN   0x04    /* SMPTE IN LED on */
1032 #define EMU_HANA_DOCK_LEDS_1_SMPTE_OUT  0x08    /* SMPTE OUT LED on */
1033
1034 #define EMU_HANA_DOCK_LEDS_2    0x0e    /* 0xxxxxx  6 bit  Audio Dock LEDs  */
1035 #define EMU_HANA_DOCK_LEDS_2_44K        0x01    /* 44.1 kHz LED on */
1036 #define EMU_HANA_DOCK_LEDS_2_48K        0x02    /* 48 kHz LED on */
1037 #define EMU_HANA_DOCK_LEDS_2_96K        0x04    /* 96 kHz LED on */
1038 #define EMU_HANA_DOCK_LEDS_2_192K       0x08    /* 192 kHz LED on */
1039 #define EMU_HANA_DOCK_LEDS_2_LOCK       0x10    /* LOCK LED on */
1040 #define EMU_HANA_DOCK_LEDS_2_EXT        0x20    /* EXT LED on */
1041
1042 #define EMU_HANA_DOCK_LEDS_3    0x0f    /* 0xxxxxx  6 bit  Audio Dock LEDs  */
1043 #define EMU_HANA_DOCK_LEDS_3_CLIP_A     0x01    /* Mic A Clip LED on */
1044 #define EMU_HANA_DOCK_LEDS_3_CLIP_B     0x02    /* Mic B Clip LED on */
1045 #define EMU_HANA_DOCK_LEDS_3_SIGNAL_A   0x04    /* Signal A Clip LED on */
1046 #define EMU_HANA_DOCK_LEDS_3_SIGNAL_B   0x08    /* Signal B Clip LED on */
1047 #define EMU_HANA_DOCK_LEDS_3_MANUAL_CLIP        0x10    /* Manual Clip detection */
1048 #define EMU_HANA_DOCK_LEDS_3_MANUAL_SIGNAL      0x20    /* Manual Signal detection */
1049
1050 #define EMU_HANA_ADC_PADS       0x10    /* 0000xxx  3 bit  Audio Dock ADC 14dB pads */
1051 #define EMU_HANA_DOCK_ADC_PAD1  0x01    /* 14dB Attenuation on Audio Dock ADC 1 */
1052 #define EMU_HANA_DOCK_ADC_PAD2  0x02    /* 14dB Attenuation on Audio Dock ADC 2 */
1053 #define EMU_HANA_DOCK_ADC_PAD3  0x04    /* 14dB Attenuation on Audio Dock ADC 3 */
1054 #define EMU_HANA_0202_ADC_PAD1  0x08    /* 14dB Attenuation on 0202 ADC 1 */
1055
1056 #define EMU_HANA_DOCK_MISC      0x11    /* 0xxxxxx  6 bit  Audio Dock misc bits */
1057 #define EMU_HANA_DOCK_DAC1_MUTE 0x01    /* DAC 1 Mute */
1058 #define EMU_HANA_DOCK_DAC2_MUTE 0x02    /* DAC 2 Mute */
1059 #define EMU_HANA_DOCK_DAC3_MUTE 0x04    /* DAC 3 Mute */
1060 #define EMU_HANA_DOCK_DAC4_MUTE 0x08    /* DAC 4 Mute */
1061 #define EMU_HANA_DOCK_PHONES_192_DAC1   0x00    /* DAC 1 Headphones source at 192kHz */
1062 #define EMU_HANA_DOCK_PHONES_192_DAC2   0x10    /* DAC 2 Headphones source at 192kHz */
1063 #define EMU_HANA_DOCK_PHONES_192_DAC3   0x20    /* DAC 3 Headphones source at 192kHz */
1064 #define EMU_HANA_DOCK_PHONES_192_DAC4   0x30    /* DAC 4 Headphones source at 192kHz */
1065
1066 #define EMU_HANA_MIDI_OUT       0x12    /* 00xxxxx  5 bit  Source for each MIDI out port */
1067 #define EMU_HANA_MIDI_OUT_0202  0x01 /* 0202 MIDI from Alice 2. 0 = A, 1 = B */
1068 #define EMU_HANA_MIDI_OUT_DOCK1 0x02 /* Audio Dock MIDI1 front, from Alice 2. 0 = A, 1 = B */
1069 #define EMU_HANA_MIDI_OUT_DOCK2 0x04 /* Audio Dock MIDI2 rear, from Alice 2. 0 = A, 1 = B */
1070 #define EMU_HANA_MIDI_OUT_SYNC2 0x08 /* Sync card. Not the actual MIDI out jack. 0 = A, 1 = B */
1071 #define EMU_HANA_MIDI_OUT_LOOP  0x10 /* 0 = bits (3:0) normal. 1 = MIDI loopback enabled. */
1072
1073 #define EMU_HANA_DAC_PADS       0x13    /* 00xxxxx  5 bit  DAC 14dB attenuation pads */
1074 #define EMU_HANA_DOCK_DAC_PAD1  0x01    /* 14dB Attenuation on AudioDock DAC 1. Left and Right */
1075 #define EMU_HANA_DOCK_DAC_PAD2  0x02    /* 14dB Attenuation on AudioDock DAC 2. Left and Right */
1076 #define EMU_HANA_DOCK_DAC_PAD3  0x04    /* 14dB Attenuation on AudioDock DAC 3. Left and Right */
1077 #define EMU_HANA_DOCK_DAC_PAD4  0x08    /* 14dB Attenuation on AudioDock DAC 4. Left and Right */
1078 #define EMU_HANA_0202_DAC_PAD1  0x10    /* 14dB Attenuation on 0202 DAC 1. Left and Right */
1079
1080 /* 0x14 - 0x1f Unused R/W registers */
1081 #define EMU_HANA_IRQ_STATUS     0x20    /* 000xxxx  4 bits IRQ Status  */
1082 #if 0  /* Already defined for reg 0x09 IRQ_ENABLE */
1083 #define EMU_HANA_IRQ_WCLK_CHANGED       0x01
1084 #define EMU_HANA_IRQ_ADAT               0x02
1085 #define EMU_HANA_IRQ_DOCK               0x04
1086 #define EMU_HANA_IRQ_DOCK_LOST          0x08
1087 #endif
1088
1089 #define EMU_HANA_OPTION_CARDS   0x21    /* 000xxxx  4 bits Presence of option cards */
1090 #define EMU_HANA_OPTION_HAMOA   0x01    /* HAMOA card present */
1091 #define EMU_HANA_OPTION_SYNC    0x02    /* Sync card present */
1092 #define EMU_HANA_OPTION_DOCK_ONLINE     0x04    /* Audio Dock online and FPGA configured */
1093 #define EMU_HANA_OPTION_DOCK_OFFLINE    0x08    /* Audio Dock online and FPGA not configured */
1094
1095 #define EMU_HANA_ID             0x22    /* 1010101  7 bits ID byte & 0x7f = 0x55 */
1096
1097 #define EMU_HANA_MAJOR_REV      0x23    /* 0000xxx  3 bit  Hana FPGA Major rev */
1098 #define EMU_HANA_MINOR_REV      0x24    /* 0000xxx  3 bit  Hana FPGA Minor rev */
1099
1100 #define EMU_DOCK_MAJOR_REV      0x25    /* 0000xxx  3 bit  Audio Dock FPGA Major rev */
1101 #define EMU_DOCK_MINOR_REV      0x26    /* 0000xxx  3 bit  Audio Dock FPGA Minor rev */
1102
1103 #define EMU_DOCK_BOARD_ID       0x27    /* 00000xx  2 bits Audio Dock ID pins */
1104 #define EMU_DOCK_BOARD_ID0      0x00    /* ID bit 0 */
1105 #define EMU_DOCK_BOARD_ID1      0x03    /* ID bit 1 */
1106
1107 #define EMU_HANA_WC_SPDIF_HI    0x28    /* 0xxxxxx  6 bit  SPDIF IN Word clock, upper 6 bits */
1108 #define EMU_HANA_WC_SPDIF_LO    0x29    /* 0xxxxxx  6 bit  SPDIF IN Word clock, lower 6 bits */
1109
1110 #define EMU_HANA_WC_ADAT_HI     0x2a    /* 0xxxxxx  6 bit  ADAT IN Word clock, upper 6 bits */
1111 #define EMU_HANA_WC_ADAT_LO     0x2b    /* 0xxxxxx  6 bit  ADAT IN Word clock, lower 6 bits */
1112
1113 #define EMU_HANA_WC_BNC_LO      0x2c    /* 0xxxxxx  6 bit  BNC IN Word clock, lower 6 bits */
1114 #define EMU_HANA_WC_BNC_HI      0x2d    /* 0xxxxxx  6 bit  BNC IN Word clock, upper 6 bits */
1115
1116 #define EMU_HANA2_WC_SPDIF_HI   0x2e    /* 0xxxxxx  6 bit  HANA2 SPDIF IN Word clock, upper 6 bits */
1117 #define EMU_HANA2_WC_SPDIF_LO   0x2f    /* 0xxxxxx  6 bit  HANA2 SPDIF IN Word clock, lower 6 bits */
1118 /* 0x30 - 0x3f Unused Read only registers */
1119
1120 /************************************************************************************************/
1121 /* EMU1010m HANA Destinations                                                                   */
1122 /************************************************************************************************/
1123 /* 32-bit destinations of signal in the Hana FPGA. Destinations are either
1124  * physical outputs of Hana, or outputs going to Alice2 (audigy) for capture
1125  * - 16 x EMU_DST_ALICE2_EMU32_X.
1126  */
1127 /* EMU32 = 32-bit serial channel between Alice2 (audigy) and Hana (FPGA) */
1128 /* EMU_DST_ALICE2_EMU32_X - data channels from Hana to Alice2 used for capture.
1129  * Which data is fed into a EMU_DST_ALICE2_EMU32_X channel in Hana depends on
1130  * setup of mixer control for each destination - see emumixer.c -
1131  * snd_emu1010_output_enum_ctls[], snd_emu1010_input_enum_ctls[]
1132  */
1133 #define EMU_DST_ALICE2_EMU32_0  0x000f  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1134 #define EMU_DST_ALICE2_EMU32_1  0x0000  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1135 #define EMU_DST_ALICE2_EMU32_2  0x0001  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1136 #define EMU_DST_ALICE2_EMU32_3  0x0002  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1137 #define EMU_DST_ALICE2_EMU32_4  0x0003  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1138 #define EMU_DST_ALICE2_EMU32_5  0x0004  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1139 #define EMU_DST_ALICE2_EMU32_6  0x0005  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1140 #define EMU_DST_ALICE2_EMU32_7  0x0006  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1141 #define EMU_DST_ALICE2_EMU32_8  0x0007  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1142 #define EMU_DST_ALICE2_EMU32_9  0x0008  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1143 #define EMU_DST_ALICE2_EMU32_A  0x0009  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1144 #define EMU_DST_ALICE2_EMU32_B  0x000a  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1145 #define EMU_DST_ALICE2_EMU32_C  0x000b  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1146 #define EMU_DST_ALICE2_EMU32_D  0x000c  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1147 #define EMU_DST_ALICE2_EMU32_E  0x000d  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1148 #define EMU_DST_ALICE2_EMU32_F  0x000e  /* 16 EMU32 channels to Alice2 +0 to +0xf */
1149 #define EMU_DST_DOCK_DAC1_LEFT1 0x0100  /* Audio Dock DAC1 Left, 1st or 48kHz only */
1150 #define EMU_DST_DOCK_DAC1_LEFT2 0x0101  /* Audio Dock DAC1 Left, 2nd or 96kHz */
1151 #define EMU_DST_DOCK_DAC1_LEFT3 0x0102  /* Audio Dock DAC1 Left, 3rd or 192kHz */
1152 #define EMU_DST_DOCK_DAC1_LEFT4 0x0103  /* Audio Dock DAC1 Left, 4th or 192kHz */
1153 #define EMU_DST_DOCK_DAC1_RIGHT1        0x0104  /* Audio Dock DAC1 Right, 1st or 48kHz only */
1154 #define EMU_DST_DOCK_DAC1_RIGHT2        0x0105  /* Audio Dock DAC1 Right, 2nd or 96kHz */
1155 #define EMU_DST_DOCK_DAC1_RIGHT3        0x0106  /* Audio Dock DAC1 Right, 3rd or 192kHz */
1156 #define EMU_DST_DOCK_DAC1_RIGHT4        0x0107  /* Audio Dock DAC1 Right, 4th or 192kHz */
1157 #define EMU_DST_DOCK_DAC2_LEFT1 0x0108  /* Audio Dock DAC2 Left, 1st or 48kHz only */
1158 #define EMU_DST_DOCK_DAC2_LEFT2 0x0109  /* Audio Dock DAC2 Left, 2nd or 96kHz */
1159 #define EMU_DST_DOCK_DAC2_LEFT3 0x010a  /* Audio Dock DAC2 Left, 3rd or 192kHz */
1160 #define EMU_DST_DOCK_DAC2_LEFT4 0x010b  /* Audio Dock DAC2 Left, 4th or 192kHz */
1161 #define EMU_DST_DOCK_DAC2_RIGHT1        0x010c  /* Audio Dock DAC2 Right, 1st or 48kHz only */
1162 #define EMU_DST_DOCK_DAC2_RIGHT2        0x010d  /* Audio Dock DAC2 Right, 2nd or 96kHz */
1163 #define EMU_DST_DOCK_DAC2_RIGHT3        0x010e  /* Audio Dock DAC2 Right, 3rd or 192kHz */
1164 #define EMU_DST_DOCK_DAC2_RIGHT4        0x010f  /* Audio Dock DAC2 Right, 4th or 192kHz */
1165 #define EMU_DST_DOCK_DAC3_LEFT1 0x0110  /* Audio Dock DAC1 Left, 1st or 48kHz only */
1166 #define EMU_DST_DOCK_DAC3_LEFT2 0x0111  /* Audio Dock DAC1 Left, 2nd or 96kHz */
1167 #define EMU_DST_DOCK_DAC3_LEFT3 0x0112  /* Audio Dock DAC1 Left, 3rd or 192kHz */
1168 #define EMU_DST_DOCK_DAC3_LEFT4 0x0113  /* Audio Dock DAC1 Left, 4th or 192kHz */
1169 #define EMU_DST_DOCK_PHONES_LEFT1       0x0112  /* Audio Dock PHONES Left, 1st or 48kHz only */
1170 #define EMU_DST_DOCK_PHONES_LEFT2       0x0113  /* Audio Dock PHONES Left, 2nd or 96kHz */
1171 #define EMU_DST_DOCK_DAC3_RIGHT1        0x0114  /* Audio Dock DAC1 Right, 1st or 48kHz only */
1172 #define EMU_DST_DOCK_DAC3_RIGHT2        0x0115  /* Audio Dock DAC1 Right, 2nd or 96kHz */
1173 #define EMU_DST_DOCK_DAC3_RIGHT3        0x0116  /* Audio Dock DAC1 Right, 3rd or 192kHz */
1174 #define EMU_DST_DOCK_DAC3_RIGHT4        0x0117  /* Audio Dock DAC1 Right, 4th or 192kHz */
1175 #define EMU_DST_DOCK_PHONES_RIGHT1      0x0116  /* Audio Dock PHONES Right, 1st or 48kHz only */
1176 #define EMU_DST_DOCK_PHONES_RIGHT2      0x0117  /* Audio Dock PHONES Right, 2nd or 96kHz */
1177 #define EMU_DST_DOCK_DAC4_LEFT1 0x0118  /* Audio Dock DAC2 Left, 1st or 48kHz only */
1178 #define EMU_DST_DOCK_DAC4_LEFT2 0x0119  /* Audio Dock DAC2 Left, 2nd or 96kHz */
1179 #define EMU_DST_DOCK_DAC4_LEFT3 0x011a  /* Audio Dock DAC2 Left, 3rd or 192kHz */
1180 #define EMU_DST_DOCK_DAC4_LEFT4 0x011b  /* Audio Dock DAC2 Left, 4th or 192kHz */
1181 #define EMU_DST_DOCK_SPDIF_LEFT1        0x011a  /* Audio Dock SPDIF Left, 1st or 48kHz only */
1182 #define EMU_DST_DOCK_SPDIF_LEFT2        0x011b  /* Audio Dock SPDIF Left, 2nd or 96kHz */
1183 #define EMU_DST_DOCK_DAC4_RIGHT1        0x011c  /* Audio Dock DAC2 Right, 1st or 48kHz only */
1184 #define EMU_DST_DOCK_DAC4_RIGHT2        0x011d  /* Audio Dock DAC2 Right, 2nd or 96kHz */
1185 #define EMU_DST_DOCK_DAC4_RIGHT3        0x011e  /* Audio Dock DAC2 Right, 3rd or 192kHz */
1186 #define EMU_DST_DOCK_DAC4_RIGHT4        0x011f  /* Audio Dock DAC2 Right, 4th or 192kHz */
1187 #define EMU_DST_DOCK_SPDIF_RIGHT1       0x011e  /* Audio Dock SPDIF Right, 1st or 48kHz only */
1188 #define EMU_DST_DOCK_SPDIF_RIGHT2       0x011f  /* Audio Dock SPDIF Right, 2nd or 96kHz */
1189 #define EMU_DST_HANA_SPDIF_LEFT1        0x0200  /* Hana SPDIF Left, 1st or 48kHz only */
1190 #define EMU_DST_HANA_SPDIF_LEFT2        0x0202  /* Hana SPDIF Left, 2nd or 96kHz */
1191 #define EMU_DST_HANA_SPDIF_RIGHT1       0x0201  /* Hana SPDIF Right, 1st or 48kHz only */
1192 #define EMU_DST_HANA_SPDIF_RIGHT2       0x0203  /* Hana SPDIF Right, 2nd or 96kHz */
1193 #define EMU_DST_HAMOA_DAC_LEFT1 0x0300  /* Hamoa DAC Left, 1st or 48kHz only */
1194 #define EMU_DST_HAMOA_DAC_LEFT2 0x0302  /* Hamoa DAC Left, 2nd or 96kHz */
1195 #define EMU_DST_HAMOA_DAC_LEFT3 0x0304  /* Hamoa DAC Left, 3rd or 192kHz */
1196 #define EMU_DST_HAMOA_DAC_LEFT4 0x0306  /* Hamoa DAC Left, 4th or 192kHz */
1197 #define EMU_DST_HAMOA_DAC_RIGHT1        0x0301  /* Hamoa DAC Right, 1st or 48kHz only */
1198 #define EMU_DST_HAMOA_DAC_RIGHT2        0x0303  /* Hamoa DAC Right, 2nd or 96kHz */
1199 #define EMU_DST_HAMOA_DAC_RIGHT3        0x0305  /* Hamoa DAC Right, 3rd or 192kHz */
1200 #define EMU_DST_HAMOA_DAC_RIGHT4        0x0307  /* Hamoa DAC Right, 4th or 192kHz */
1201 #define EMU_DST_HANA_ADAT       0x0400  /* Hana ADAT 8 channel out +0 to +7 */
1202 #define EMU_DST_ALICE_I2S0_LEFT         0x0500  /* Alice2 I2S0 Left */
1203 #define EMU_DST_ALICE_I2S0_RIGHT        0x0501  /* Alice2 I2S0 Right */
1204 #define EMU_DST_ALICE_I2S1_LEFT         0x0600  /* Alice2 I2S1 Left */
1205 #define EMU_DST_ALICE_I2S1_RIGHT        0x0601  /* Alice2 I2S1 Right */
1206 #define EMU_DST_ALICE_I2S2_LEFT         0x0700  /* Alice2 I2S2 Left */
1207 #define EMU_DST_ALICE_I2S2_RIGHT        0x0701  /* Alice2 I2S2 Right */
1208
1209 /************************************************************************************************/
1210 /* EMU1010m HANA Sources                                                                        */
1211 /************************************************************************************************/
1212 /* 32-bit sources of signal in the Hana FPGA. The sources are routed to
1213  * destinations using mixer control for each destination - see emumixer.c
1214  * Sources are either physical inputs of FPGA,
1215  * or outputs from Alice (audigy) - 16 x EMU_SRC_ALICE_EMU32A +
1216  * 16 x EMU_SRC_ALICE_EMU32B
1217  */
1218 #define EMU_SRC_SILENCE         0x0000  /* Silence */
1219 #define EMU_SRC_DOCK_MIC_A1     0x0100  /* Audio Dock Mic A, 1st or 48kHz only */
1220 #define EMU_SRC_DOCK_MIC_A2     0x0101  /* Audio Dock Mic A, 2nd or 96kHz */
1221 #define EMU_SRC_DOCK_MIC_A3     0x0102  /* Audio Dock Mic A, 3rd or 192kHz */
1222 #define EMU_SRC_DOCK_MIC_A4     0x0103  /* Audio Dock Mic A, 4th or 192kHz */
1223 #define EMU_SRC_DOCK_MIC_B1     0x0104  /* Audio Dock Mic B, 1st or 48kHz only */
1224 #define EMU_SRC_DOCK_MIC_B2     0x0105  /* Audio Dock Mic B, 2nd or 96kHz */
1225 #define EMU_SRC_DOCK_MIC_B3     0x0106  /* Audio Dock Mic B, 3rd or 192kHz */
1226 #define EMU_SRC_DOCK_MIC_B4     0x0107  /* Audio Dock Mic B, 4th or 192kHz */
1227 #define EMU_SRC_DOCK_ADC1_LEFT1 0x0108  /* Audio Dock ADC1 Left, 1st or 48kHz only */
1228 #define EMU_SRC_DOCK_ADC1_LEFT2 0x0109  /* Audio Dock ADC1 Left, 2nd or 96kHz */
1229 #define EMU_SRC_DOCK_ADC1_LEFT3 0x010a  /* Audio Dock ADC1 Left, 3rd or 192kHz */
1230 #define EMU_SRC_DOCK_ADC1_LEFT4 0x010b  /* Audio Dock ADC1 Left, 4th or 192kHz */
1231 #define EMU_SRC_DOCK_ADC1_RIGHT1        0x010c  /* Audio Dock ADC1 Right, 1st or 48kHz only */
1232 #define EMU_SRC_DOCK_ADC1_RIGHT2        0x010d  /* Audio Dock ADC1 Right, 2nd or 96kHz */
1233 #define EMU_SRC_DOCK_ADC1_RIGHT3        0x010e  /* Audio Dock ADC1 Right, 3rd or 192kHz */
1234 #define EMU_SRC_DOCK_ADC1_RIGHT4        0x010f  /* Audio Dock ADC1 Right, 4th or 192kHz */
1235 #define EMU_SRC_DOCK_ADC2_LEFT1 0x0110  /* Audio Dock ADC2 Left, 1st or 48kHz only */
1236 #define EMU_SRC_DOCK_ADC2_LEFT2 0x0111  /* Audio Dock ADC2 Left, 2nd or 96kHz */
1237 #define EMU_SRC_DOCK_ADC2_LEFT3 0x0112  /* Audio Dock ADC2 Left, 3rd or 192kHz */
1238 #define EMU_SRC_DOCK_ADC2_LEFT4 0x0113  /* Audio Dock ADC2 Left, 4th or 192kHz */
1239 #define EMU_SRC_DOCK_ADC2_RIGHT1        0x0114  /* Audio Dock ADC2 Right, 1st or 48kHz only */
1240 #define EMU_SRC_DOCK_ADC2_RIGHT2        0x0115  /* Audio Dock ADC2 Right, 2nd or 96kHz */
1241 #define EMU_SRC_DOCK_ADC2_RIGHT3        0x0116  /* Audio Dock ADC2 Right, 3rd or 192kHz */
1242 #define EMU_SRC_DOCK_ADC2_RIGHT4        0x0117  /* Audio Dock ADC2 Right, 4th or 192kHz */
1243 #define EMU_SRC_DOCK_ADC3_LEFT1 0x0118  /* Audio Dock ADC3 Left, 1st or 48kHz only */
1244 #define EMU_SRC_DOCK_ADC3_LEFT2 0x0119  /* Audio Dock ADC3 Left, 2nd or 96kHz */
1245 #define EMU_SRC_DOCK_ADC3_LEFT3 0x011a  /* Audio Dock ADC3 Left, 3rd or 192kHz */
1246 #define EMU_SRC_DOCK_ADC3_LEFT4 0x011b  /* Audio Dock ADC3 Left, 4th or 192kHz */
1247 #define EMU_SRC_DOCK_ADC3_RIGHT1        0x011c  /* Audio Dock ADC3 Right, 1st or 48kHz only */
1248 #define EMU_SRC_DOCK_ADC3_RIGHT2        0x011d  /* Audio Dock ADC3 Right, 2nd or 96kHz */
1249 #define EMU_SRC_DOCK_ADC3_RIGHT3        0x011e  /* Audio Dock ADC3 Right, 3rd or 192kHz */
1250 #define EMU_SRC_DOCK_ADC3_RIGHT4        0x011f  /* Audio Dock ADC3 Right, 4th or 192kHz */
1251 #define EMU_SRC_HAMOA_ADC_LEFT1 0x0200  /* Hamoa ADC Left, 1st or 48kHz only */
1252 #define EMU_SRC_HAMOA_ADC_LEFT2 0x0202  /* Hamoa ADC Left, 2nd or 96kHz */
1253 #define EMU_SRC_HAMOA_ADC_LEFT3 0x0204  /* Hamoa ADC Left, 3rd or 192kHz */
1254 #define EMU_SRC_HAMOA_ADC_LEFT4 0x0206  /* Hamoa ADC Left, 4th or 192kHz */
1255 #define EMU_SRC_HAMOA_ADC_RIGHT1        0x0201  /* Hamoa ADC Right, 1st or 48kHz only */
1256 #define EMU_SRC_HAMOA_ADC_RIGHT2        0x0203  /* Hamoa ADC Right, 2nd or 96kHz */
1257 #define EMU_SRC_HAMOA_ADC_RIGHT3        0x0205  /* Hamoa ADC Right, 3rd or 192kHz */
1258 #define EMU_SRC_HAMOA_ADC_RIGHT4        0x0207  /* Hamoa ADC Right, 4th or 192kHz */
1259 #define EMU_SRC_ALICE_EMU32A            0x0300  /* Alice2 EMU32a 16 outputs. +0 to +0xf */
1260 #define EMU_SRC_ALICE_EMU32B            0x0310  /* Alice2 EMU32b 16 outputs. +0 to +0xf */
1261 #define EMU_SRC_HANA_ADAT       0x0400  /* Hana ADAT 8 channel in +0 to +7 */
1262 #define EMU_SRC_HANA_SPDIF_LEFT1        0x0500  /* Hana SPDIF Left, 1st or 48kHz only */
1263 #define EMU_SRC_HANA_SPDIF_LEFT2        0x0502  /* Hana SPDIF Left, 2nd or 96kHz */
1264 #define EMU_SRC_HANA_SPDIF_RIGHT1       0x0501  /* Hana SPDIF Right, 1st or 48kHz only */
1265 #define EMU_SRC_HANA_SPDIF_RIGHT2       0x0503  /* Hana SPDIF Right, 2nd or 96kHz */
1266 /* 0x600 and 0x700 no used */
1267
1268 /* ------------------- STRUCTURES -------------------- */
1269
1270 enum {
1271         EMU10K1_EFX,
1272         EMU10K1_PCM,
1273         EMU10K1_SYNTH,
1274         EMU10K1_MIDI
1275 };
1276
1277 struct snd_emu10k1;
1278
1279 struct snd_emu10k1_voice {
1280         struct snd_emu10k1 *emu;
1281         int number;
1282         unsigned int use: 1,
1283             pcm: 1,
1284             efx: 1,
1285             synth: 1,
1286             midi: 1;
1287         void (*interrupt)(struct snd_emu10k1 *emu, struct snd_emu10k1_voice *pvoice);
1288
1289         struct snd_emu10k1_pcm *epcm;
1290 };
1291
1292 enum {
1293         PLAYBACK_EMUVOICE,
1294         PLAYBACK_EFX,
1295         CAPTURE_AC97ADC,
1296         CAPTURE_AC97MIC,
1297         CAPTURE_EFX
1298 };
1299
1300 struct snd_emu10k1_pcm {
1301         struct snd_emu10k1 *emu;
1302         int type;
1303         struct snd_pcm_substream *substream;
1304         struct snd_emu10k1_voice *voices[NUM_EFX_PLAYBACK];
1305         struct snd_emu10k1_voice *extra;
1306         unsigned short running;
1307         unsigned short first_ptr;
1308         struct snd_util_memblk *memblk;
1309         unsigned int start_addr;
1310         unsigned int ccca_start_addr;
1311         unsigned int capture_ipr;       /* interrupt acknowledge mask */
1312         unsigned int capture_inte;      /* interrupt enable mask */
1313         unsigned int capture_ba_reg;    /* buffer address register */
1314         unsigned int capture_bs_reg;    /* buffer size register */
1315         unsigned int capture_idx_reg;   /* buffer index register */
1316         unsigned int capture_cr_val;    /* control value */
1317         unsigned int capture_cr_val2;   /* control value2 (for audigy) */
1318         unsigned int capture_bs_val;    /* buffer size value */
1319         unsigned int capture_bufsize;   /* buffer size in bytes */
1320 };
1321
1322 struct snd_emu10k1_pcm_mixer {
1323         /* mono, left, right x 8 sends (4 on emu10k1) */
1324         unsigned char send_routing[3][8];
1325         unsigned char send_volume[3][8];
1326         unsigned short attn[3];
1327         struct snd_emu10k1_pcm *epcm;
1328 };
1329
1330 #define snd_emu10k1_compose_send_routing(route) \
1331 ((route[0] | (route[1] << 4) | (route[2] << 8) | (route[3] << 12)) << 16)
1332
1333 #define snd_emu10k1_compose_audigy_fxrt1(route) \
1334 ((unsigned int)route[0] | ((unsigned int)route[1] << 8) | ((unsigned int)route[2] << 16) | ((unsigned int)route[3] << 24))
1335
1336 #define snd_emu10k1_compose_audigy_fxrt2(route) \
1337 ((unsigned int)route[4] | ((unsigned int)route[5] << 8) | ((unsigned int)route[6] << 16) | ((unsigned int)route[7] << 24))
1338
1339 struct snd_emu10k1_memblk {
1340         struct snd_util_memblk mem;
1341         /* private part */
1342         int first_page, last_page, pages, mapped_page;
1343         unsigned int map_locked;
1344         struct list_head mapped_link;
1345         struct list_head mapped_order_link;
1346 };
1347
1348 #define snd_emu10k1_memblk_offset(blk)  (((blk)->mapped_page << PAGE_SHIFT) | ((blk)->mem.offset & (PAGE_SIZE - 1)))
1349
1350 #define EMU10K1_MAX_TRAM_BLOCKS_PER_CODE        16
1351
1352 struct snd_emu10k1_fx8010_ctl {
1353         struct list_head list;          /* list link container */
1354         unsigned int vcount;
1355         unsigned int count;             /* count of GPR (1..16) */
1356         unsigned short gpr[32];         /* GPR number(s) */
1357         unsigned int value[32];
1358         unsigned int min;               /* minimum range */
1359         unsigned int max;               /* maximum range */
1360         unsigned int translation;       /* translation type (EMU10K1_GPR_TRANSLATION*) */
1361         struct snd_kcontrol *kcontrol;
1362 };
1363
1364 typedef void (snd_fx8010_irq_handler_t)(struct snd_emu10k1 *emu, void *private_data);
1365
1366 struct snd_emu10k1_fx8010_irq {
1367         struct snd_emu10k1_fx8010_irq *next;
1368         snd_fx8010_irq_handler_t *handler;
1369         unsigned short gpr_running;
1370         void *private_data;
1371 };
1372
1373 struct snd_emu10k1_fx8010_pcm {
1374         unsigned int valid: 1,
1375                      opened: 1,
1376                      active: 1;
1377         unsigned int channels;          /* 16-bit channels count */
1378         unsigned int tram_start;        /* initial ring buffer position in TRAM (in samples) */
1379         unsigned int buffer_size;       /* count of buffered samples */
1380         unsigned short gpr_size;                /* GPR containing size of ring buffer in samples (host) */
1381         unsigned short gpr_ptr;         /* GPR containing current pointer in the ring buffer (host = reset, FX8010) */
1382         unsigned short gpr_count;       /* GPR containing count of samples between two interrupts (host) */
1383         unsigned short gpr_tmpcount;    /* GPR containing current count of samples to interrupt (host = set, FX8010) */
1384         unsigned short gpr_trigger;     /* GPR containing trigger (activate) information (host) */
1385         unsigned short gpr_running;     /* GPR containing info if PCM is running (FX8010) */
1386         unsigned char etram[32];        /* external TRAM address & data */
1387         struct snd_pcm_indirect pcm_rec;
1388         unsigned int tram_pos;
1389         unsigned int tram_shift;
1390         struct snd_emu10k1_fx8010_irq *irq;
1391 };
1392
1393 struct snd_emu10k1_fx8010 {
1394         unsigned short fxbus_mask;      /* used FX buses (bitmask) */
1395         unsigned short extin_mask;      /* used external inputs (bitmask) */
1396         unsigned short extout_mask;     /* used external outputs (bitmask) */
1397         unsigned short pad1;
1398         unsigned int itram_size;        /* internal TRAM size in samples */
1399         struct snd_dma_buffer etram_pages; /* external TRAM pages and size */
1400         unsigned int dbg;               /* FX debugger register */
1401         unsigned char name[128];
1402         int gpr_size;                   /* size of allocated GPR controls */
1403         int gpr_count;                  /* count of used kcontrols */
1404         struct list_head gpr_ctl;       /* GPR controls */
1405         struct mutex lock;
1406         struct snd_emu10k1_fx8010_pcm pcm[8];
1407         spinlock_t irq_lock;
1408         struct snd_emu10k1_fx8010_irq *irq_handlers;
1409 };
1410
1411 struct snd_emu10k1_midi {
1412         struct snd_emu10k1 *emu;
1413         struct snd_rawmidi *rmidi;
1414         struct snd_rawmidi_substream *substream_input;
1415         struct snd_rawmidi_substream *substream_output;
1416         unsigned int midi_mode;
1417         spinlock_t input_lock;
1418         spinlock_t output_lock;
1419         spinlock_t open_lock;
1420         int tx_enable, rx_enable;
1421         int port;
1422         int ipr_tx, ipr_rx;
1423         void (*interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1424 };
1425
1426 struct snd_emu_chip_details {
1427         u32 vendor;
1428         u32 device;
1429         u32 subsystem;
1430         unsigned char revision;
1431         unsigned char emu10k1_chip; /* Original SB Live. Not SB Live 24bit. */
1432         unsigned char emu10k2_chip; /* Audigy 1 or Audigy 2. */
1433         unsigned char ca0102_chip;  /* Audigy 1 or Audigy 2. Not SB Audigy 2 Value. */
1434         unsigned char ca0108_chip;  /* Audigy 2 Value */
1435         unsigned char ca_cardbus_chip; /* Audigy 2 ZS Notebook */
1436         unsigned char ca0151_chip;  /* P16V */
1437         unsigned char spk71;        /* Has 7.1 speakers */
1438         unsigned char sblive51;     /* SBLive! 5.1 - extout 0x11 -> center, 0x12 -> lfe */
1439         unsigned char spdif_bug;    /* Has Spdif phasing bug */
1440         unsigned char ac97_chip;    /* Has an AC97 chip: 1 = mandatory, 2 = optional */
1441         unsigned char ecard;        /* APS EEPROM */
1442         unsigned char emu1010;     /* EMU 1010m card */
1443         unsigned char spi_dac;      /* SPI interface for DAC */
1444         unsigned char i2c_adc;      /* I2C interface for ADC */
1445         unsigned char adc_1361t;    /* Use Philips 1361T ADC */
1446         const char *driver;
1447         const char *name;
1448         const char *id;         /* for backward compatibility - can be NULL if not needed */
1449 };
1450
1451 struct snd_emu1010 {
1452         unsigned int output_source[64];
1453         unsigned int input_source[64];
1454         unsigned int adc_pads; /* bit mask */
1455         unsigned int dac_pads; /* bit mask */
1456         unsigned int internal_clock; /* 44100 or 48000 */
1457         unsigned int optical_in; /* 0:SPDIF, 1:ADAT */
1458         unsigned int optical_out; /* 0:SPDIF, 1:ADAT */
1459         struct task_struct *firmware_thread;
1460 };
1461
1462 struct snd_emu10k1 {
1463         int irq;
1464
1465         unsigned long port;                     /* I/O port number */
1466         unsigned int tos_link: 1,               /* tos link detected */
1467                 rear_ac97: 1,                   /* rear channels are on AC'97 */
1468                 enable_ir: 1;
1469         unsigned int support_tlv :1;
1470         /* Contains profile of card capabilities */
1471         const struct snd_emu_chip_details *card_capabilities;
1472         unsigned int audigy;                    /* is Audigy? */
1473         unsigned int revision;                  /* chip revision */
1474         unsigned int serial;                    /* serial number */
1475         unsigned short model;                   /* subsystem id */
1476         unsigned int card_type;                 /* EMU10K1_CARD_* */
1477         unsigned int ecard_ctrl;                /* ecard control bits */
1478         unsigned long dma_mask;                 /* PCI DMA mask */
1479         int max_cache_pages;                    /* max memory size / PAGE_SIZE */
1480         struct snd_dma_buffer silent_page;      /* silent page */
1481         struct snd_dma_buffer ptb_pages;        /* page table pages */
1482         struct snd_dma_device p16v_dma_dev;
1483         struct snd_dma_buffer p16v_buffer;
1484
1485         struct snd_util_memhdr *memhdr;         /* page allocation list */
1486         struct snd_emu10k1_memblk *reserved_page;       /* reserved page */
1487
1488         struct list_head mapped_link_head;
1489         struct list_head mapped_order_link_head;
1490         void **page_ptr_table;
1491         unsigned long *page_addr_table;
1492         spinlock_t memblk_lock;
1493
1494         unsigned int spdif_bits[3];             /* s/pdif out setup */
1495         unsigned int i2c_capture_source;
1496         u8 i2c_capture_volume[4][2];
1497
1498         struct snd_emu10k1_fx8010 fx8010;               /* FX8010 info */
1499         int gpr_base;
1500         
1501         struct snd_ac97 *ac97;
1502
1503         struct pci_dev *pci;
1504         struct snd_card *card;
1505         struct snd_pcm *pcm;
1506         struct snd_pcm *pcm_mic;
1507         struct snd_pcm *pcm_efx;
1508         struct snd_pcm *pcm_multi;
1509         struct snd_pcm *pcm_p16v;
1510
1511         spinlock_t synth_lock;
1512         void *synth;
1513         int (*get_synth_voice)(struct snd_emu10k1 *emu);
1514
1515         spinlock_t reg_lock;
1516         spinlock_t emu_lock;
1517         spinlock_t voice_lock;
1518
1519         struct snd_emu10k1_voice voices[NUM_G];
1520         struct snd_emu10k1_voice p16v_voices[4];
1521         struct snd_emu10k1_voice p16v_capture_voice;
1522         int p16v_device_offset;
1523         u32 p16v_capture_source;
1524         u32 p16v_capture_channel;
1525         struct snd_emu1010 emu1010;
1526         struct snd_emu10k1_pcm_mixer pcm_mixer[32];
1527         struct snd_emu10k1_pcm_mixer efx_pcm_mixer[NUM_EFX_PLAYBACK];
1528         struct snd_kcontrol *ctl_send_routing;
1529         struct snd_kcontrol *ctl_send_volume;
1530         struct snd_kcontrol *ctl_attn;
1531         struct snd_kcontrol *ctl_efx_send_routing;
1532         struct snd_kcontrol *ctl_efx_send_volume;
1533         struct snd_kcontrol *ctl_efx_attn;
1534
1535         void (*hwvol_interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1536         void (*capture_interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1537         void (*capture_mic_interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1538         void (*capture_efx_interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1539         void (*spdif_interrupt)(struct snd_emu10k1 *emu, unsigned int status);
1540         void (*dsp_interrupt)(struct snd_emu10k1 *emu);
1541
1542         struct snd_pcm_substream *pcm_capture_substream;
1543         struct snd_pcm_substream *pcm_capture_mic_substream;
1544         struct snd_pcm_substream *pcm_capture_efx_substream;
1545         struct snd_pcm_substream *pcm_playback_efx_substream;
1546
1547         struct snd_timer *timer;
1548
1549         struct snd_emu10k1_midi midi;
1550         struct snd_emu10k1_midi midi2; /* for audigy */
1551
1552         unsigned int efx_voices_mask[2];
1553         unsigned int next_free_voice;
1554
1555 #ifdef CONFIG_PM
1556         unsigned int *saved_ptr;
1557         unsigned int *saved_gpr;
1558         unsigned int *tram_val_saved;
1559         unsigned int *tram_addr_saved;
1560         unsigned int *saved_icode;
1561         unsigned int *p16v_saved;
1562         unsigned int saved_a_iocfg, saved_hcfg;
1563 #endif
1564
1565 };
1566
1567 int snd_emu10k1_create(struct snd_card *card,
1568                        struct pci_dev *pci,
1569                        unsigned short extin_mask,
1570                        unsigned short extout_mask,
1571                        long max_cache_bytes,
1572                        int enable_ir,
1573                        uint subsystem,
1574                        struct snd_emu10k1 ** remu);
1575
1576 int snd_emu10k1_pcm(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1577 int snd_emu10k1_pcm_mic(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1578 int snd_emu10k1_pcm_efx(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1579 int snd_p16v_pcm(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1580 int snd_p16v_free(struct snd_emu10k1 * emu);
1581 int snd_p16v_mixer(struct snd_emu10k1 * emu);
1582 int snd_emu10k1_pcm_multi(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1583 int snd_emu10k1_fx8010_pcm(struct snd_emu10k1 * emu, int device, struct snd_pcm ** rpcm);
1584 int snd_emu10k1_mixer(struct snd_emu10k1 * emu, int pcm_device, int multi_device);
1585 int snd_emu10k1_timer(struct snd_emu10k1 * emu, int device);
1586 int snd_emu10k1_fx8010_new(struct snd_emu10k1 *emu, int device, struct snd_hwdep ** rhwdep);
1587
1588 irqreturn_t snd_emu10k1_interrupt(int irq, void *dev_id);
1589
1590 void snd_emu10k1_voice_init(struct snd_emu10k1 * emu, int voice);
1591 int snd_emu10k1_init_efx(struct snd_emu10k1 *emu);
1592 void snd_emu10k1_free_efx(struct snd_emu10k1 *emu);
1593 int snd_emu10k1_fx8010_tram_setup(struct snd_emu10k1 *emu, u32 size);
1594 int snd_emu10k1_done(struct snd_emu10k1 * emu);
1595
1596 /* I/O functions */
1597 unsigned int snd_emu10k1_ptr_read(struct snd_emu10k1 * emu, unsigned int reg, unsigned int chn);
1598 void snd_emu10k1_ptr_write(struct snd_emu10k1 *emu, unsigned int reg, unsigned int chn, unsigned int data);
1599 unsigned int snd_emu10k1_ptr20_read(struct snd_emu10k1 * emu, unsigned int reg, unsigned int chn);
1600 void snd_emu10k1_ptr20_write(struct snd_emu10k1 *emu, unsigned int reg, unsigned int chn, unsigned int data);
1601 int snd_emu10k1_spi_write(struct snd_emu10k1 * emu, unsigned int data);
1602 int snd_emu10k1_i2c_write(struct snd_emu10k1 *emu, u32 reg, u32 value);
1603 int snd_emu1010_fpga_write(struct snd_emu10k1 * emu, u32 reg, u32 value);
1604 int snd_emu1010_fpga_read(struct snd_emu10k1 * emu, u32 reg, u32 *value);
1605 int snd_emu1010_fpga_link_dst_src_write(struct snd_emu10k1 * emu, u32 dst, u32 src);
1606 unsigned int snd_emu10k1_efx_read(struct snd_emu10k1 *emu, unsigned int pc);
1607 void snd_emu10k1_intr_enable(struct snd_emu10k1 *emu, unsigned int intrenb);
1608 void snd_emu10k1_intr_disable(struct snd_emu10k1 *emu, unsigned int intrenb);
1609 void snd_emu10k1_voice_intr_enable(struct snd_emu10k1 *emu, unsigned int voicenum);
1610 void snd_emu10k1_voice_intr_disable(struct snd_emu10k1 *emu, unsigned int voicenum);
1611 void snd_emu10k1_voice_intr_ack(struct snd_emu10k1 *emu, unsigned int voicenum);
1612 void snd_emu10k1_voice_half_loop_intr_enable(struct snd_emu10k1 *emu, unsigned int voicenum);
1613 void snd_emu10k1_voice_half_loop_intr_disable(struct snd_emu10k1 *emu, unsigned int voicenum);
1614 void snd_emu10k1_voice_half_loop_intr_ack(struct snd_emu10k1 *emu, unsigned int voicenum);
1615 void snd_emu10k1_voice_set_loop_stop(struct snd_emu10k1 *emu, unsigned int voicenum);
1616 void snd_emu10k1_voice_clear_loop_stop(struct snd_emu10k1 *emu, unsigned int voicenum);
1617 void snd_emu10k1_wait(struct snd_emu10k1 *emu, unsigned int wait);
1618 static inline unsigned int snd_emu10k1_wc(struct snd_emu10k1 *emu) { return (inl(emu->port + WC) >> 6) & 0xfffff; }
1619 unsigned short snd_emu10k1_ac97_read(struct snd_ac97 *ac97, unsigned short reg);
1620 void snd_emu10k1_ac97_write(struct snd_ac97 *ac97, unsigned short reg, unsigned short data);
1621 unsigned int snd_emu10k1_rate_to_pitch(unsigned int rate);
1622
1623 #ifdef CONFIG_PM
1624 void snd_emu10k1_suspend_regs(struct snd_emu10k1 *emu);
1625 void snd_emu10k1_resume_init(struct snd_emu10k1 *emu);
1626 void snd_emu10k1_resume_regs(struct snd_emu10k1 *emu);
1627 int snd_emu10k1_efx_alloc_pm_buffer(struct snd_emu10k1 *emu);
1628 void snd_emu10k1_efx_free_pm_buffer(struct snd_emu10k1 *emu);
1629 void snd_emu10k1_efx_suspend(struct snd_emu10k1 *emu);
1630 void snd_emu10k1_efx_resume(struct snd_emu10k1 *emu);
1631 int snd_p16v_alloc_pm_buffer(struct snd_emu10k1 *emu);
1632 void snd_p16v_free_pm_buffer(struct snd_emu10k1 *emu);
1633 void snd_p16v_suspend(struct snd_emu10k1 *emu);
1634 void snd_p16v_resume(struct snd_emu10k1 *emu);
1635 #endif
1636
1637 /* memory allocation */
1638 struct snd_util_memblk *snd_emu10k1_alloc_pages(struct snd_emu10k1 *emu, struct snd_pcm_substream *substream);
1639 int snd_emu10k1_free_pages(struct snd_emu10k1 *emu, struct snd_util_memblk *blk);
1640 struct snd_util_memblk *snd_emu10k1_synth_alloc(struct snd_emu10k1 *emu, unsigned int size);
1641 int snd_emu10k1_synth_free(struct snd_emu10k1 *emu, struct snd_util_memblk *blk);
1642 int snd_emu10k1_synth_bzero(struct snd_emu10k1 *emu, struct snd_util_memblk *blk, int offset, int size);
1643 int snd_emu10k1_synth_copy_from_user(struct snd_emu10k1 *emu, struct snd_util_memblk *blk, int offset, const char __user *data, int size);
1644 int snd_emu10k1_memblk_map(struct snd_emu10k1 *emu, struct snd_emu10k1_memblk *blk);
1645
1646 /* voice allocation */
1647 int snd_emu10k1_voice_alloc(struct snd_emu10k1 *emu, int type, int pair, struct snd_emu10k1_voice **rvoice);
1648 int snd_emu10k1_voice_free(struct snd_emu10k1 *emu, struct snd_emu10k1_voice *pvoice);
1649
1650 /* MIDI uart */
1651 int snd_emu10k1_midi(struct snd_emu10k1 * emu);
1652 int snd_emu10k1_audigy_midi(struct snd_emu10k1 * emu);
1653
1654 /* proc interface */
1655 int snd_emu10k1_proc_init(struct snd_emu10k1 * emu);
1656
1657 /* fx8010 irq handler */
1658 int snd_emu10k1_fx8010_register_irq_handler(struct snd_emu10k1 *emu,
1659                                             snd_fx8010_irq_handler_t *handler,
1660                                             unsigned char gpr_running,
1661                                             void *private_data,
1662                                             struct snd_emu10k1_fx8010_irq **r_irq);
1663 int snd_emu10k1_fx8010_unregister_irq_handler(struct snd_emu10k1 *emu,
1664                                               struct snd_emu10k1_fx8010_irq *irq);
1665
1666 #endif /* __KERNEL__ */
1667
1668 /*
1669  * ---- FX8010 ----
1670  */
1671
1672 #define EMU10K1_CARD_CREATIVE                   0x00000000
1673 #define EMU10K1_CARD_EMUAPS                     0x00000001
1674
1675 #define EMU10K1_FX8010_PCM_COUNT                8
1676
1677 /* instruction set */
1678 #define iMAC0    0x00   /* R = A + (X * Y >> 31)   ; saturation */
1679 #define iMAC1    0x01   /* R = A + (-X * Y >> 31)  ; saturation */
1680 #define iMAC2    0x02   /* R = A + (X * Y >> 31)   ; wraparound */
1681 #define iMAC3    0x03   /* R = A + (-X * Y >> 31)  ; wraparound */
1682 #define iMACINT0 0x04   /* R = A + X * Y           ; saturation */
1683 #define iMACINT1 0x05   /* R = A + X * Y           ; wraparound (31-bit) */
1684 #define iACC3    0x06   /* R = A + X + Y           ; saturation */
1685 #define iMACMV   0x07   /* R = A, acc += X * Y >> 31 */
1686 #define iANDXOR  0x08   /* R = (A & X) ^ Y */
1687 #define iTSTNEG  0x09   /* R = (A >= Y) ? X : ~X */
1688 #define iLIMITGE 0x0a   /* R = (A >= Y) ? X : Y */
1689 #define iLIMITLT 0x0b   /* R = (A < Y) ? X : Y */
1690 #define iLOG     0x0c   /* R = linear_data, A (log_data), X (max_exp), Y (format_word) */
1691 #define iEXP     0x0d   /* R = log_data, A (linear_data), X (max_exp), Y (format_word) */
1692 #define iINTERP  0x0e   /* R = A + (X * (Y - A) >> 31)  ; saturation */
1693 #define iSKIP    0x0f   /* R = A (cc_reg), X (count), Y (cc_test) */
1694
1695 /* GPRs */
1696 #define FXBUS(x)        (0x00 + (x))    /* x = 0x00 - 0x0f */
1697 #define EXTIN(x)        (0x10 + (x))    /* x = 0x00 - 0x0f */
1698 #define EXTOUT(x)       (0x20 + (x))    /* x = 0x00 - 0x0f physical outs -> FXWC low 16 bits */
1699 #define FXBUS2(x)       (0x30 + (x))    /* x = 0x00 - 0x0f copies of fx buses for capture -> FXWC high 16 bits */
1700                                         /* NB: 0x31 and 0x32 are shared with Center/LFE on SB live 5.1 */
1701
1702 #define C_00000000      0x40
1703 #define C_00000001      0x41
1704 #define C_00000002      0x42
1705 #define C_00000003      0x43
1706 #define C_00000004      0x44
1707 #define C_00000008      0x45
1708 #define C_00000010      0x46
1709 #define C_00000020      0x47
1710 #define C_00000100      0x48
1711 #define C_00010000      0x49
1712 #define C_00080000      0x4a
1713 #define C_10000000      0x4b
1714 #define C_20000000      0x4c
1715 #define C_40000000      0x4d
1716 #define C_80000000      0x4e
1717 #define C_7fffffff      0x4f
1718 #define C_ffffffff      0x50
1719 #define C_fffffffe      0x51
1720 #define C_c0000000      0x52
1721 #define C_4f1bbcdc      0x53
1722 #define C_5a7ef9db      0x54
1723 #define C_00100000      0x55            /* ?? */
1724 #define GPR_ACCU        0x56            /* ACCUM, accumulator */
1725 #define GPR_COND        0x57            /* CCR, condition register */
1726 #define GPR_NOISE0      0x58            /* noise source */
1727 #define GPR_NOISE1      0x59            /* noise source */
1728 #define GPR_IRQ         0x5a            /* IRQ register */
1729 #define GPR_DBAC        0x5b            /* TRAM Delay Base Address Counter */
1730 #define GPR(x)          (FXGPREGBASE + (x)) /* free GPRs: x = 0x00 - 0xff */
1731 #define ITRAM_DATA(x)   (TANKMEMDATAREGBASE + 0x00 + (x)) /* x = 0x00 - 0x7f */
1732 #define ETRAM_DATA(x)   (TANKMEMDATAREGBASE + 0x80 + (x)) /* x = 0x00 - 0x1f */
1733 #define ITRAM_ADDR(x)   (TANKMEMADDRREGBASE + 0x00 + (x)) /* x = 0x00 - 0x7f */
1734 #define ETRAM_ADDR(x)   (TANKMEMADDRREGBASE + 0x80 + (x)) /* x = 0x00 - 0x1f */
1735
1736 #define A_ITRAM_DATA(x) (TANKMEMDATAREGBASE + 0x00 + (x)) /* x = 0x00 - 0xbf */
1737 #define A_ETRAM_DATA(x) (TANKMEMDATAREGBASE + 0xc0 + (x)) /* x = 0x00 - 0x3f */
1738 #define A_ITRAM_ADDR(x) (TANKMEMADDRREGBASE + 0x00 + (x)) /* x = 0x00 - 0xbf */
1739 #define A_ETRAM_ADDR(x) (TANKMEMADDRREGBASE + 0xc0 + (x)) /* x = 0x00 - 0x3f */
1740 #define A_ITRAM_CTL(x)  (A_TANKMEMCTLREGBASE + 0x00 + (x)) /* x = 0x00 - 0xbf */
1741 #define A_ETRAM_CTL(x)  (A_TANKMEMCTLREGBASE + 0xc0 + (x)) /* x = 0x00 - 0x3f */
1742
1743 #define A_FXBUS(x)      (0x00 + (x))    /* x = 0x00 - 0x3f FX buses */
1744 #define A_EXTIN(x)      (0x40 + (x))    /* x = 0x00 - 0x0f physical ins */
1745 #define A_P16VIN(x)     (0x50 + (x))    /* x = 0x00 - 0x0f p16v ins (A2 only) "EMU32 inputs" */
1746 #define A_EXTOUT(x)     (0x60 + (x))    /* x = 0x00 - 0x1f physical outs -> A_FXWC1 0x79-7f unknown   */
1747 #define A_FXBUS2(x)     (0x80 + (x))    /* x = 0x00 - 0x1f extra outs used for EFX capture -> A_FXWC2 */
1748 #define A_EMU32OUTH(x)  (0xa0 + (x))    /* x = 0x00 - 0x0f "EMU32_OUT_10 - _1F" - ??? */
1749 #define A_EMU32OUTL(x)  (0xb0 + (x))    /* x = 0x00 - 0x0f "EMU32_OUT_1 - _F" - ??? */
1750 #define A3_EMU32IN(x)   (0x160 + (x))   /* x = 0x00 - 0x3f "EMU32_IN_00 - _3F" - Only when .device = 0x0008 */
1751 #define A3_EMU32OUT(x)  (0x1E0 + (x))   /* x = 0x00 - 0x0f "EMU32_OUT_00 - _3F" - Only when .device = 0x0008 */
1752 #define A_GPR(x)        (A_FXGPREGBASE + (x))
1753
1754 /* cc_reg constants */
1755 #define CC_REG_NORMALIZED C_00000001
1756 #define CC_REG_BORROW   C_00000002
1757 #define CC_REG_MINUS    C_00000004
1758 #define CC_REG_ZERO     C_00000008
1759 #define CC_REG_SATURATE C_00000010
1760 #define CC_REG_NONZERO  C_00000100
1761
1762 /* FX buses */
1763 #define FXBUS_PCM_LEFT          0x00
1764 #define FXBUS_PCM_RIGHT         0x01
1765 #define FXBUS_PCM_LEFT_REAR     0x02
1766 #define FXBUS_PCM_RIGHT_REAR    0x03
1767 #define FXBUS_MIDI_LEFT         0x04
1768 #define FXBUS_MIDI_RIGHT        0x05
1769 #define FXBUS_PCM_CENTER        0x06
1770 #define FXBUS_PCM_LFE           0x07
1771 #define FXBUS_PCM_LEFT_FRONT    0x08
1772 #define FXBUS_PCM_RIGHT_FRONT   0x09
1773 #define FXBUS_MIDI_REVERB       0x0c
1774 #define FXBUS_MIDI_CHORUS       0x0d
1775 #define FXBUS_PCM_LEFT_SIDE     0x0e
1776 #define FXBUS_PCM_RIGHT_SIDE    0x0f
1777 #define FXBUS_PT_LEFT           0x14
1778 #define FXBUS_PT_RIGHT          0x15
1779
1780 /* Inputs */
1781 #define EXTIN_AC97_L       0x00 /* AC'97 capture channel - left */
1782 #define EXTIN_AC97_R       0x01 /* AC'97 capture channel - right */
1783 #define EXTIN_SPDIF_CD_L   0x02 /* internal S/PDIF CD - onboard - left */
1784 #define EXTIN_SPDIF_CD_R   0x03 /* internal S/PDIF CD - onboard - right */
1785 #define EXTIN_ZOOM_L       0x04 /* Zoom Video I2S - left */
1786 #define EXTIN_ZOOM_R       0x05 /* Zoom Video I2S - right */
1787 #define EXTIN_TOSLINK_L    0x06 /* LiveDrive - TOSLink Optical - left */
1788 #define EXTIN_TOSLINK_R    0x07 /* LiveDrive - TOSLink Optical - right */
1789 #define EXTIN_LINE1_L      0x08 /* LiveDrive - Line/Mic 1 - left */
1790 #define EXTIN_LINE1_R      0x09 /* LiveDrive - Line/Mic 1 - right */
1791 #define EXTIN_COAX_SPDIF_L 0x0a /* LiveDrive - Coaxial S/PDIF - left */
1792 #define EXTIN_COAX_SPDIF_R 0x0b /* LiveDrive - Coaxial S/PDIF - right */
1793 #define EXTIN_LINE2_L      0x0c /* LiveDrive - Line/Mic 2 - left */
1794 #define EXTIN_LINE2_R      0x0d /* LiveDrive - Line/Mic 2 - right */
1795
1796 /* Outputs */
1797 #define EXTOUT_AC97_L      0x00 /* AC'97 playback channel - left */
1798 #define EXTOUT_AC97_R      0x01 /* AC'97 playback channel - right */
1799 #define EXTOUT_TOSLINK_L   0x02 /* LiveDrive - TOSLink Optical - left */
1800 #define EXTOUT_TOSLINK_R   0x03 /* LiveDrive - TOSLink Optical - right */
1801 #define EXTOUT_AC97_CENTER 0x04 /* SB Live 5.1 - center */
1802 #define EXTOUT_AC97_LFE    0x05 /* SB Live 5.1 - LFE */
1803 #define EXTOUT_HEADPHONE_L 0x06 /* LiveDrive - Headphone - left */
1804 #define EXTOUT_HEADPHONE_R 0x07 /* LiveDrive - Headphone - right */
1805 #define EXTOUT_REAR_L      0x08 /* Rear channel - left */
1806 #define EXTOUT_REAR_R      0x09 /* Rear channel - right */
1807 #define EXTOUT_ADC_CAP_L   0x0a /* ADC Capture buffer - left */
1808 #define EXTOUT_ADC_CAP_R   0x0b /* ADC Capture buffer - right */
1809 #define EXTOUT_MIC_CAP     0x0c /* MIC Capture buffer */
1810 #define EXTOUT_AC97_REAR_L 0x0d /* SB Live 5.1 (c) 2003 - Rear Left */
1811 #define EXTOUT_AC97_REAR_R 0x0e /* SB Live 5.1 (c) 2003 - Rear Right */
1812 #define EXTOUT_ACENTER     0x11 /* Analog Center */
1813 #define EXTOUT_ALFE        0x12 /* Analog LFE */
1814
1815 /* Audigy Inputs */
1816 #define A_EXTIN_AC97_L          0x00    /* AC'97 capture channel - left */
1817 #define A_EXTIN_AC97_R          0x01    /* AC'97 capture channel - right */
1818 #define A_EXTIN_SPDIF_CD_L      0x02    /* digital CD left */
1819 #define A_EXTIN_SPDIF_CD_R      0x03    /* digital CD left */
1820 #define A_EXTIN_OPT_SPDIF_L     0x04    /* audigy drive Optical SPDIF - left */
1821 #define A_EXTIN_OPT_SPDIF_R     0x05    /*                              right */ 
1822 #define A_EXTIN_LINE2_L         0x08    /* audigy drive line2/mic2 - left */
1823 #define A_EXTIN_LINE2_R         0x09    /*                           right */
1824 #define A_EXTIN_ADC_L           0x0a    /* Philips ADC - left */
1825 #define A_EXTIN_ADC_R           0x0b    /*               right */
1826 #define A_EXTIN_AUX2_L          0x0c    /* audigy drive aux2 - left */
1827 #define A_EXTIN_AUX2_R          0x0d    /*                   - right */
1828
1829 /* Audigiy Outputs */
1830 #define A_EXTOUT_FRONT_L        0x00    /* digital front left */
1831 #define A_EXTOUT_FRONT_R        0x01    /*               right */
1832 #define A_EXTOUT_CENTER         0x02    /* digital front center */
1833 #define A_EXTOUT_LFE            0x03    /* digital front lfe */
1834 #define A_EXTOUT_HEADPHONE_L    0x04    /* headphone audigy drive left */
1835 #define A_EXTOUT_HEADPHONE_R    0x05    /*                        right */
1836 #define A_EXTOUT_REAR_L         0x06    /* digital rear left */
1837 #define A_EXTOUT_REAR_R         0x07    /*              right */
1838 #define A_EXTOUT_AFRONT_L       0x08    /* analog front left */
1839 #define A_EXTOUT_AFRONT_R       0x09    /*              right */
1840 #define A_EXTOUT_ACENTER        0x0a    /* analog center */
1841 #define A_EXTOUT_ALFE           0x0b    /* analog LFE */
1842 #define A_EXTOUT_ASIDE_L        0x0c    /* analog side left  - Audigy 2 ZS */
1843 #define A_EXTOUT_ASIDE_R        0x0d    /*             right - Audigy 2 ZS */
1844 #define A_EXTOUT_AREAR_L        0x0e    /* analog rear left */
1845 #define A_EXTOUT_AREAR_R        0x0f    /*             right */
1846 #define A_EXTOUT_AC97_L         0x10    /* AC97 left (front) */
1847 #define A_EXTOUT_AC97_R         0x11    /*      right */
1848 #define A_EXTOUT_ADC_CAP_L      0x16    /* ADC capture buffer left */
1849 #define A_EXTOUT_ADC_CAP_R      0x17    /*                    right */
1850 #define A_EXTOUT_MIC_CAP        0x18    /* Mic capture buffer */
1851
1852 /* Audigy constants */
1853 #define A_C_00000000    0xc0
1854 #define A_C_00000001    0xc1
1855 #define A_C_00000002    0xc2
1856 #define A_C_00000003    0xc3
1857 #define A_C_00000004    0xc4
1858 #define A_C_00000008    0xc5
1859 #define A_C_00000010    0xc6
1860 #define A_C_00000020    0xc7
1861 #define A_C_00000100    0xc8
1862 #define A_C_00010000    0xc9
1863 #define A_C_00000800    0xca
1864 #define A_C_10000000    0xcb
1865 #define A_C_20000000    0xcc
1866 #define A_C_40000000    0xcd
1867 #define A_C_80000000    0xce
1868 #define A_C_7fffffff    0xcf
1869 #define A_C_ffffffff    0xd0
1870 #define A_C_fffffffe    0xd1
1871 #define A_C_c0000000    0xd2
1872 #define A_C_4f1bbcdc    0xd3
1873 #define A_C_5a7ef9db    0xd4
1874 #define A_C_00100000    0xd5
1875 #define A_GPR_ACCU      0xd6            /* ACCUM, accumulator */
1876 #define A_GPR_COND      0xd7            /* CCR, condition register */
1877 #define A_GPR_NOISE0    0xd8            /* noise source */
1878 #define A_GPR_NOISE1    0xd9            /* noise source */
1879 #define A_GPR_IRQ       0xda            /* IRQ register */
1880 #define A_GPR_DBAC      0xdb            /* TRAM Delay Base Address Counter - internal */
1881 #define A_GPR_DBACE     0xde            /* TRAM Delay Base Address Counter - external */
1882
1883 /* definitions for debug register */
1884 #define EMU10K1_DBG_ZC                  0x80000000      /* zero tram counter */
1885 #define EMU10K1_DBG_SATURATION_OCCURED  0x02000000      /* saturation control */
1886 #define EMU10K1_DBG_SATURATION_ADDR     0x01ff0000      /* saturation address */
1887 #define EMU10K1_DBG_SINGLE_STEP         0x00008000      /* single step mode */
1888 #define EMU10K1_DBG_STEP                0x00004000      /* start single step */
1889 #define EMU10K1_DBG_CONDITION_CODE      0x00003e00      /* condition code */
1890 #define EMU10K1_DBG_SINGLE_STEP_ADDR    0x000001ff      /* single step address */
1891
1892 /* tank memory address line */
1893 #ifndef __KERNEL__
1894 #define TANKMEMADDRREG_ADDR_MASK 0x000fffff     /* 20 bit tank address field                    */
1895 #define TANKMEMADDRREG_CLEAR     0x00800000     /* Clear tank memory                            */
1896 #define TANKMEMADDRREG_ALIGN     0x00400000     /* Align read or write relative to tank access  */
1897 #define TANKMEMADDRREG_WRITE     0x00200000     /* Write to tank memory                         */
1898 #define TANKMEMADDRREG_READ      0x00100000     /* Read from tank memory                        */
1899 #endif
1900
1901 struct snd_emu10k1_fx8010_info {
1902         unsigned int internal_tram_size;        /* in samples */
1903         unsigned int external_tram_size;        /* in samples */
1904         char fxbus_names[16][32];               /* names of FXBUSes */
1905         char extin_names[16][32];               /* names of external inputs */
1906         char extout_names[32][32];              /* names of external outputs */
1907         unsigned int gpr_controls;              /* count of GPR controls */
1908 };
1909
1910 #define EMU10K1_GPR_TRANSLATION_NONE            0
1911 #define EMU10K1_GPR_TRANSLATION_TABLE100        1
1912 #define EMU10K1_GPR_TRANSLATION_BASS            2
1913 #define EMU10K1_GPR_TRANSLATION_TREBLE          3
1914 #define EMU10K1_GPR_TRANSLATION_ONOFF           4
1915
1916 struct snd_emu10k1_fx8010_control_gpr {
1917         struct snd_ctl_elem_id id;              /* full control ID definition */
1918         unsigned int vcount;            /* visible count */
1919         unsigned int count;             /* count of GPR (1..16) */
1920         unsigned short gpr[32];         /* GPR number(s) */
1921         unsigned int value[32];         /* initial values */
1922         unsigned int min;               /* minimum range */
1923         unsigned int max;               /* maximum range */
1924         unsigned int translation;       /* translation type (EMU10K1_GPR_TRANSLATION*) */
1925         const unsigned int *tlv;
1926 };
1927
1928 /* old ABI without TLV support */
1929 struct snd_emu10k1_fx8010_control_old_gpr {
1930         struct snd_ctl_elem_id id;
1931         unsigned int vcount;
1932         unsigned int count;
1933         unsigned short gpr[32];
1934         unsigned int value[32];
1935         unsigned int min;
1936         unsigned int max;
1937         unsigned int translation;
1938 };
1939
1940 struct snd_emu10k1_fx8010_code {
1941         char name[128];
1942
1943         DECLARE_BITMAP(gpr_valid, 0x200); /* bitmask of valid initializers */
1944         u_int32_t __user *gpr_map;        /* initializers */
1945
1946         unsigned int gpr_add_control_count; /* count of GPR controls to add/replace */
1947         struct snd_emu10k1_fx8010_control_gpr __user *gpr_add_controls; /* GPR controls to add/replace */
1948
1949         unsigned int gpr_del_control_count; /* count of GPR controls to remove */
1950         struct snd_ctl_elem_id __user *gpr_del_controls; /* IDs of GPR controls to remove */
1951
1952         unsigned int gpr_list_control_count; /* count of GPR controls to list */
1953         unsigned int gpr_list_control_total; /* total count of GPR controls */
1954         struct snd_emu10k1_fx8010_control_gpr __user *gpr_list_controls; /* listed GPR controls */
1955
1956         DECLARE_BITMAP(tram_valid, 0x100); /* bitmask of valid initializers */
1957         u_int32_t __user *tram_data_map;  /* data initializers */
1958         u_int32_t __user *tram_addr_map;  /* map initializers */
1959
1960         DECLARE_BITMAP(code_valid, 1024); /* bitmask of valid instructions */
1961         u_int32_t __user *code;           /* one instruction - 64 bits */
1962 };
1963
1964 struct snd_emu10k1_fx8010_tram {
1965         unsigned int address;           /* 31.bit == 1 -> external TRAM */
1966         unsigned int size;              /* size in samples (4 bytes) */
1967         unsigned int *samples;          /* pointer to samples (20-bit) */
1968                                         /* NULL->clear memory */
1969 };
1970
1971 struct snd_emu10k1_fx8010_pcm_rec {
1972         unsigned int substream;         /* substream number */
1973         unsigned int res1;              /* reserved */
1974         unsigned int channels;          /* 16-bit channels count, zero = remove this substream */
1975         unsigned int tram_start;        /* ring buffer position in TRAM (in samples) */
1976         unsigned int buffer_size;       /* count of buffered samples */
1977         unsigned short gpr_size;                /* GPR containing size of ringbuffer in samples (host) */
1978         unsigned short gpr_ptr;         /* GPR containing current pointer in the ring buffer (host = reset, FX8010) */
1979         unsigned short gpr_count;       /* GPR containing count of samples between two interrupts (host) */
1980         unsigned short gpr_tmpcount;    /* GPR containing current count of samples to interrupt (host = set, FX8010) */
1981         unsigned short gpr_trigger;     /* GPR containing trigger (activate) information (host) */
1982         unsigned short gpr_running;     /* GPR containing info if PCM is running (FX8010) */
1983         unsigned char pad;              /* reserved */
1984         unsigned char etram[32];        /* external TRAM address & data (one per channel) */
1985         unsigned int res2;              /* reserved */
1986 };
1987
1988 #define SNDRV_EMU10K1_VERSION           SNDRV_PROTOCOL_VERSION(1, 0, 1)
1989
1990 #define SNDRV_EMU10K1_IOCTL_INFO        _IOR ('H', 0x10, struct snd_emu10k1_fx8010_info)
1991 #define SNDRV_EMU10K1_IOCTL_CODE_POKE   _IOW ('H', 0x11, struct snd_emu10k1_fx8010_code)
1992 #define SNDRV_EMU10K1_IOCTL_CODE_PEEK   _IOWR('H', 0x12, struct snd_emu10k1_fx8010_code)
1993 #define SNDRV_EMU10K1_IOCTL_TRAM_SETUP  _IOW ('H', 0x20, int)
1994 #define SNDRV_EMU10K1_IOCTL_TRAM_POKE   _IOW ('H', 0x21, struct snd_emu10k1_fx8010_tram)
1995 #define SNDRV_EMU10K1_IOCTL_TRAM_PEEK   _IOWR('H', 0x22, struct snd_emu10k1_fx8010_tram)
1996 #define SNDRV_EMU10K1_IOCTL_PCM_POKE    _IOW ('H', 0x30, struct snd_emu10k1_fx8010_pcm_rec)
1997 #define SNDRV_EMU10K1_IOCTL_PCM_PEEK    _IOWR('H', 0x31, struct snd_emu10k1_fx8010_pcm_rec)
1998 #define SNDRV_EMU10K1_IOCTL_PVERSION    _IOR ('H', 0x40, int)
1999 #define SNDRV_EMU10K1_IOCTL_STOP        _IO  ('H', 0x80)
2000 #define SNDRV_EMU10K1_IOCTL_CONTINUE    _IO  ('H', 0x81)
2001 #define SNDRV_EMU10K1_IOCTL_ZERO_TRAM_COUNTER _IO ('H', 0x82)
2002 #define SNDRV_EMU10K1_IOCTL_SINGLE_STEP _IOW ('H', 0x83, int)
2003 #define SNDRV_EMU10K1_IOCTL_DBG_READ    _IOR ('H', 0x84, int)
2004
2005 /* typedefs for compatibility to user-space */
2006 typedef struct snd_emu10k1_fx8010_info emu10k1_fx8010_info_t;
2007 typedef struct snd_emu10k1_fx8010_control_gpr emu10k1_fx8010_control_gpr_t;
2008 typedef struct snd_emu10k1_fx8010_code emu10k1_fx8010_code_t;
2009 typedef struct snd_emu10k1_fx8010_tram emu10k1_fx8010_tram_t;
2010 typedef struct snd_emu10k1_fx8010_pcm_rec emu10k1_fx8010_pcm_t;
2011
2012 #endif  /* __SOUND_EMU10K1_H */