Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / sys / dev / sound / pci / gnu / emu10k1.h
1 /*
2  **********************************************************************
3  *     emu10k1.h, derived from 8010.h
4  *     Copyright 1999, 2000 Creative Labs, Inc.
5  *
6  **********************************************************************
7  *
8  *     Date                 Author          Summary of changes
9  *     ----                 ------          ------------------
10  *     October 20, 1999     Bertrand Lee    base code release
11  *     November 2, 1999     Alan Cox        Cleaned of 8bit chars, DOS
12  *                                          line endings
13  *     December 8, 1999     Jon Taylor      Added lots of new register info
14  *
15  **********************************************************************
16  *
17  *     This program is free software; you can redistribute it and/or
18  *     modify it under the terms of the GNU General Public License as
19  *     published by the Free Software Foundation; either version 2 of
20  *     the License, or (at your option) any later version.
21  *
22  *     This program is distributed in the hope that it will be useful,
23  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
24  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  *     GNU General Public License for more details.
26  *
27  *     You should have received a copy of the GNU General Public
28  *     License along with this program; if not, write to the Free
29  *     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
30  *     USA.
31  *
32  *
33  **********************************************************************
34  * $FreeBSD: src/sys/gnu/dev/sound/pci/emu10k1.h,v 1.2.2.3 2001/08/01 03:41:09 cg Exp $
35  * $DragonFly: src/sys/dev/sound/pci/gnu/emu10k1.h,v 1.2 2003/06/17 04:28:33 dillon Exp $
36  */
37
38
39 #ifndef EMU10K1_H
40 #define EMU10K1_H
41
42 /* ------------------- DEFINES -------------------- */
43
44 #define EMUPAGESIZE     4096    /* don't change */
45 #define MAXREQVOICES    8
46 #define MAXPAGES        (32768 * 64 / EMUPAGESIZE)      /* WAVEOUT_MAXBUFSIZE * NUM_G / EMUPAGESIZE */
47 #define RESERVED        0
48 #define NUM_MIDI        16
49 #define NUM_G           64              /* use all channels */
50 #define NUM_FXSENDS     4
51
52
53 #define TMEMSIZE        256*1024
54 #define TMEMSIZEREG     4
55
56 #define IP_TO_CP(ip) ((ip == 0) ? 0 : (((0x00001000uL | (ip & 0x00000FFFL)) << (((ip >> 12) & 0x000FL) + 4)) & 0xFFFF0000uL))
57
58 /************************************************************************************************/
59 /* PCI function 0 registers, address = <val> + PCIBASE0                                         */
60 /************************************************************************************************/
61
62 #define PTR                     0x00            /* Indexed register set pointer register        */
63                                                 /* NOTE: The CHANNELNUM and ADDRESS words can   */
64                                                 /* be modified independently of each other.     */
65 #define PTR_CHANNELNUM_MASK     0x0000003f      /* For each per-channel register, indicates the */
66                                                 /* channel number of the register to be         */
67                                                 /* accessed.  For non per-channel registers the */
68                                                 /* value should be set to zero.                 */
69 #define PTR_ADDRESS_MASK        0x07ff0000      /* Register index                               */
70
71 #define DATA                    0x04            /* Indexed register set data register           */
72
73 #define IPR                     0x08            /* Global interrupt pending register            */
74                                                 /* Clear pending interrupts by writing a 1 to   */
75                                                 /* the relevant bits and zero to the other bits */
76 #define IPR_SAMPLERATETRACKER   0x01000000      /* Sample rate tracker lock status change       */
77 #define IPR_FXDSP               0x00800000      /* Enable FX DSP interrupts                     */
78 #define IPR_FORCEINT            0x00400000      /* Force Sound Blaster interrupt                */
79 #define IPR_PCIERROR            0x00200000      /* PCI bus error                                */
80 #define IPR_VOLINCR             0x00100000      /* Volume increment button pressed              */
81 #define IPR_VOLDECR             0x00080000      /* Volume decrement button pressed              */
82 #define IPR_MUTE                0x00040000      /* Mute button pressed                          */
83 #define IPR_MICBUFFULL          0x00020000      /* Microphone buffer full                       */
84 #define IPR_MICBUFHALFFULL      0x00010000      /* Microphone buffer half full                  */
85 #define IPR_ADCBUFFULL          0x00008000      /* ADC buffer full                              */
86 #define IPR_ADCBUFHALFFULL      0x00004000      /* ADC buffer half full                         */
87 #define IPR_EFXBUFFULL          0x00002000      /* Effects buffer full                          */
88 #define IPR_EFXBUFHALFFULL      0x00001000      /* Effects buffer half full                     */
89 #define IPR_GPSPDIFSTATUSCHANGE 0x00000800      /* GPSPDIF channel status change                */
90 #define IPR_CDROMSTATUSCHANGE   0x00000400      /* CD-ROM channel status change                 */
91 #define IPR_INTERVALTIMER       0x00000200      /* Interval timer terminal count                */
92 #define IPR_MIDITRANSBUFEMPTY   0x00000100      /* MIDI UART transmit buffer empty              */
93 #define IPR_MIDIRECVBUFEMPTY    0x00000080      /* MIDI UART receive buffer empty               */
94 #define IPR_CHANNELLOOP         0x00000040      /* One or more channel loop interrupts pending  */
95 #define IPR_CHANNELNUMBERMASK   0x0000003f      /* When IPR_CHANNELLOOP is set, indicates the   */
96                                                 /* Highest set channel in CLIPL or CLIPH.  When */
97                                                 /* IP is written with CL set, the bit in CLIPL  */
98                                                 /* or CLIPH corresponding to the CIN value      */
99                                                 /* written will be cleared.                     */
100
101 #define INTE                    0x0c            /* Interrupt enable register                    */
102 #define INTE_VIRTUALSB_MASK     0xc0000000      /* Virtual Soundblaster I/O port capture        */
103 #define INTE_VIRTUALSB_220      0x00000000      /* Capture at I/O base address 0x220-0x22f      */
104 #define INTE_VIRTUALSB_240      0x40000000      /* Capture at I/O base address 0x240            */
105 #define INTE_VIRTUALSB_260      0x80000000      /* Capture at I/O base address 0x260            */
106 #define INTE_VIRTUALSB_280      0xc0000000      /* Capture at I/O base address 0x280            */
107 #define INTE_VIRTUALMPU_MASK    0x30000000      /* Virtual MPU I/O port capture                 */
108 #define INTE_VIRTUALMPU_300     0x00000000      /* Capture at I/O base address 0x300-0x301      */
109 #define INTE_VIRTUALMPU_310     0x10000000      /* Capture at I/O base address 0x310            */
110 #define INTE_VIRTUALMPU_320     0x20000000      /* Capture at I/O base address 0x320            */
111 #define INTE_VIRTUALMPU_330     0x30000000      /* Capture at I/O base address 0x330            */
112 #define INTE_MASTERDMAENABLE    0x08000000      /* Master DMA emulation at 0x000-0x00f          */
113 #define INTE_SLAVEDMAENABLE     0x04000000      /* Slave DMA emulation at 0x0c0-0x0df           */
114 #define INTE_MASTERPICENABLE    0x02000000      /* Master PIC emulation at 0x020-0x021          */
115 #define INTE_SLAVEPICENABLE     0x01000000      /* Slave PIC emulation at 0x0a0-0x0a1           */
116 #define INTE_VSBENABLE          0x00800000      /* Enable virtual Soundblaster                  */
117 #define INTE_ADLIBENABLE        0x00400000      /* Enable AdLib emulation at 0x388-0x38b        */
118 #define INTE_MPUENABLE          0x00200000      /* Enable virtual MPU                           */
119 #define INTE_FORCEINT           0x00100000      /* Continuously assert INTAN                    */
120
121 #define INTE_MRHANDENABLE       0x00080000      /* Enable the "Mr. Hand" logic                  */
122                                                 /* NOTE: There is no reason to use this under   */
123                                                 /* Linux, and it will cause odd hardware        */
124                                                 /* behavior and possibly random segfaults and   */
125                                                 /* lockups if enabled.                          */
126
127 #define INTE_SAMPLERATETRACKER  0x00002000      /* Enable sample rate tracker interrupts        */
128                                                 /* NOTE: This bit must always be enabled        */
129 #define INTE_FXDSPENABLE        0x00001000      /* Enable FX DSP interrupts                     */
130 #define INTE_PCIERRORENABLE     0x00000800      /* Enable PCI bus error interrupts              */
131 #define INTE_VOLINCRENABLE      0x00000400      /* Enable volume increment button interrupts    */
132 #define INTE_VOLDECRENABLE      0x00000200      /* Enable volume decrement button interrupts    */
133 #define INTE_MUTEENABLE         0x00000100      /* Enable mute button interrupts                */
134 #define INTE_MICBUFENABLE       0x00000080      /* Enable microphone buffer interrupts          */
135 #define INTE_ADCBUFENABLE       0x00000040      /* Enable ADC buffer interrupts                 */
136 #define INTE_EFXBUFENABLE       0x00000020      /* Enable Effects buffer interrupts             */
137 #define INTE_GPSPDIFENABLE      0x00000010      /* Enable GPSPDIF status interrupts             */
138 #define INTE_CDSPDIFENABLE      0x00000008      /* Enable CDSPDIF status interrupts             */
139 #define INTE_INTERVALTIMERENB   0x00000004      /* Enable interval timer interrupts             */
140 #define INTE_MIDITXENABLE       0x00000002      /* Enable MIDI transmit-buffer-empty interrupts */
141 #define INTE_MIDIRXENABLE       0x00000001      /* Enable MIDI receive-buffer-empty interrupts  */
142
143 #define WC                      0x10            /* Wall Clock register                          */
144 #define WC_SAMPLECOUNTER_MASK   0x03FFFFC0      /* Sample periods elapsed since reset           */
145 #define WC_SAMPLECOUNTER        0x14060010
146 #define WC_CURRENTCHANNEL       0x0000003F      /* Channel [0..63] currently being serviced     */
147                                                 /* NOTE: Each channel takes 1/64th of a sample  */
148                                                 /* period to be serviced.                       */
149
150 #define HCFG                    0x14            /* Hardware config register                     */
151                                                 /* NOTE: There is no reason to use the legacy   */
152                                                 /* SoundBlaster emulation stuff described below */
153                                                 /* under Linux, and all kinds of weird hardware */
154                                                 /* behavior can result if you try.  Don't.      */
155 #define HCFG_LEGACYFUNC_MASK    0xe0000000      /* Legacy function number                       */
156 #define HCFG_LEGACYFUNC_MPU     0x00000000      /* Legacy MPU                                   */
157 #define HCFG_LEGACYFUNC_SB      0x40000000      /* Legacy SB                                    */
158 #define HCFG_LEGACYFUNC_AD      0x60000000      /* Legacy AD                                    */
159 #define HCFG_LEGACYFUNC_MPIC    0x80000000      /* Legacy MPIC                                  */
160 #define HCFG_LEGACYFUNC_MDMA    0xa0000000      /* Legacy MDMA                                  */
161 #define HCFG_LEGACYFUNC_SPCI    0xc0000000      /* Legacy SPCI                                  */
162 #define HCFG_LEGACYFUNC_SDMA    0xe0000000      /* Legacy SDMA                                  */
163 #define HCFG_IOCAPTUREADDR      0x1f000000      /* The 4 LSBs of the captured I/O address.      */
164 #define HCFG_LEGACYWRITE        0x00800000      /* 1 = write, 0 = read                          */
165 #define HCFG_LEGACYWORD         0x00400000      /* 1 = word, 0 = byte                           */
166 #define HCFG_LEGACYINT          0x00200000      /* 1 = legacy event captured. Write 1 to clear. */
167                                                 /* NOTE: The rest of the bits in this register  */
168                                                 /* _are_ relevant under Linux.                  */
169 #define HCFG_CODECFORMAT_MASK   0x00070000      /* CODEC format                                 */
170 #define HCFG_CODECFORMAT_AC97   0x00000000      /* AC97 CODEC format -- Primary Output          */
171 #define HCFG_CODECFORMAT_I2S    0x00010000      /* I2S CODEC format -- Secondary (Rear) Output  */
172 #define HCFG_GPINPUT0           0x00004000      /* External pin112                              */
173 #define HCFG_GPINPUT1           0x00002000      /* External pin110                              */
174 #define HCFG_GPOUTPUT_MASK      0x00001c00      /* External pins which may be controlled        */
175 #define HCFG_JOYENABLE          0x00000200      /* Internal joystick enable                     */
176 #define HCFG_PHASETRACKENABLE   0x00000100      /* Phase tracking enable                        */
177                                                 /* 1 = Force all 3 async digital inputs to use  */
178                                                 /* the same async sample rate tracker (ZVIDEO)  */
179 #define HCFG_AC3ENABLE_MASK     0x0x0000e0      /* AC3 async input control - Not implemented    */
180 #define HCFG_AC3ENABLE_ZVIDEO   0x00000080      /* Channels 0 and 1 replace ZVIDEO              */
181 #define HCFG_AC3ENABLE_CDSPDIF  0x00000040      /* Channels 0 and 1 replace CDSPDIF             */
182 #define HCFG_AUTOMUTE           0x00000010      /* When set, the async sample rate convertors   */
183                                                 /* will automatically mute their output when    */
184                                                 /* they are not rate-locked to the external     */
185                                                 /* async audio source                           */
186 #define HCFG_LOCKSOUNDCACHE     0x00000008      /* 1 = Cancel bustmaster accesses to soundcache */
187                                                 /* NOTE: This should generally never be used.   */
188 #define HCFG_LOCKTANKCACHE      0x00000004      /* 1 = Cancel bustmaster accesses to tankcache  */
189                                                 /* NOTE: This should generally never be used.   */
190 #define HCFG_MUTEBUTTONENABLE   0x00000002      /* 1 = Master mute button sets AUDIOENABLE = 0. */
191                                                 /* NOTE: This is a 'cheap' way to implement a   */
192                                                 /* master mute function on the mute button, and */
193                                                 /* in general should not be used unless a more  */
194                                                 /* sophisticated master mute function has not   */
195                                                 /* been written.                                */
196 #define HCFG_AUDIOENABLE        0x00000001      /* 0 = CODECs transmit zero-valued samples      */
197                                                 /* Should be set to 1 when the EMU10K1 is       */
198                                                 /* completely initialized.                      */
199
200 #define MUDATA                  0x18            /* MPU401 data register (8 bits)                */
201
202 #define MUCMD                   0x19            /* MPU401 command register (8 bits)             */
203 #define MUCMD_RESET             0xff            /* RESET command                                */
204 #define MUCMD_ENTERUARTMODE     0x3f            /* Enter_UART_mode command                      */
205                                                 /* NOTE: All other commands are ignored         */
206
207 #define MUSTAT                  MUCMD           /* MPU401 status register (8 bits)              */
208 #define MUSTAT_IRDYN            0x80            /* 0 = MIDI data or command ACK                 */
209 #define MUSTAT_ORDYN            0x40            /* 0 = MUDATA can accept a command or data      */
210
211 #define TIMER                   0x1a            /* Timer terminal count register                */
212                                                 /* NOTE: After the rate is changed, a maximum   */
213                                                 /* of 1024 sample periods should be allowed     */
214                                                 /* before the new rate is guaranteed accurate.  */
215 #define TIMER_RATE_MASK         0x000003ff      /* Timer interrupt rate in sample periods       */
216                                                 /* 0 == 1024 periods, [1..4] are not useful     */
217 #define TIMER_RATE              0x0a00001a
218
219 #define AC97DATA                0x1c            /* AC97 register set data register (16 bit)     */
220
221 #define AC97ADDRESS             0x1e            /* AC97 register set address register (8 bit)   */
222 #define AC97ADDRESS_READY       0x80            /* Read-only bit, reflects CODEC READY signal   */
223 #define AC97ADDRESS_ADDRESS     0x7f            /* Address of indexed AC97 register             */
224
225 /************************************************************************************************/
226 /* PCI function 1 registers, address = <val> + PCIBASE1                                         */
227 /************************************************************************************************/
228
229 #define JOYSTICK1               0x00            /* Analog joystick port register                */
230 #define JOYSTICK2               0x01            /* Analog joystick port register                */
231 #define JOYSTICK3               0x02            /* Analog joystick port register                */
232 #define JOYSTICK4               0x03            /* Analog joystick port register                */
233 #define JOYSTICK5               0x04            /* Analog joystick port register                */
234 #define JOYSTICK6               0x05            /* Analog joystick port register                */
235 #define JOYSTICK7               0x06            /* Analog joystick port register                */
236 #define JOYSTICK8               0x07            /* Analog joystick port register                */
237
238 /* When writing, any write causes JOYSTICK_COMPARATOR output enable to be pulsed on write.      */
239 /* When reading, use these bitfields: */
240 #define JOYSTICK_BUTTONS        0x0f            /* Joystick button data                         */
241 #define JOYSTICK_COMPARATOR     0xf0            /* Joystick comparator data                     */
242
243
244 /********************************************************************************************************/
245 /* AC97 pointer-offset register set, accessed through the AC97ADDRESS and AC97DATA registers            */
246 /********************************************************************************************************/
247
248 #define AC97_RESET              0x00
249 #define AC97_MASTERVOLUME       0x02            /* Master volume                                        */
250 #define AC97_HEADPHONEVOLUME    0x04            /* Headphone volume                                     */
251 #define AC97_MASTERVOLUMEMONO   0x06            /* Mast volume mono                                     */
252 #define AC97_MASTERTONE         0x08
253 #define AC97_PCBEEPVOLUME       0x0a            /* PC speaker system beep volume                        */
254 #define AC97_PHONEVOLUME        0x0c
255 #define AC97_MICVOLUME          0x0e
256 #define AC97_LINEINVOLUME       0x10
257 #define AC97_CDVOLUME           0x12
258 #define AC97_VIDEOVOLUME        0x14
259 #define AC97_AUXVOLUME          0x16
260 #define AC97_PCMOUTVOLUME       0x18
261 #define AC97_RECORDSELECT       0x1a
262 #define AC97_RECORDGAIN         0x1c
263 #define AC97_RECORDGAINMIC      0x1e
264 #define AC97_GENERALPUPOSE      0x20
265 #define AC97_3DCONTROL          0x22
266 #define AC97_MODEMRATE          0x24
267 #define AC97_POWERDOWN          0x26
268 #define AC97_VENDORID1          0x7c
269 #define AC97_VENDORID2          0x7e
270 #define AC97_ZVIDEOVOLUME       0xec
271 #define AC97_AC3VOLUME          0xed
272
273 /********************************************************************************************************/
274 /* Emu10k1 pointer-offset register set, accessed through the PTR and DATA registers                     */
275 /********************************************************************************************************/
276
277 #define CPF                     0x00            /* Current pitch and fraction register                  */
278 #define CPF_CURRENTPITCH_MASK   0xffff0000      /* Current pitch (linear, 0x4000 == unity pitch shift)  */
279 #define CPF_CURRENTPITCH        0x10100000
280 #define CPF_STEREO_MASK         0x00008000      /* 1 = Even channel interleave, odd channel locked      */
281 #define CPF_STOP_MASK           0x00004000      /* 1 = Current pitch forced to 0                        */
282 #define CPF_FRACADDRESS_MASK    0x00003fff      /* Linear fractional address of the current channel     */
283
284 #define PTRX                    0x01            /* Pitch target and send A/B amounts register           */
285 #define PTRX_PITCHTARGET_MASK   0xffff0000      /* Pitch target of specified channel                    */
286 #define PTRX_PITCHTARGET        0x10100001
287 #define PTRX_FXSENDAMOUNT_A_MASK 0x0000ff00     /* Linear level of channel output sent to FX send bus A */
288 #define PTRX_FXSENDAMOUNT_A     0x08080001
289 #define PTRX_FXSENDAMOUNT_B_MASK 0x000000ff     /* Linear level of channel output sent to FX send bus B */
290 #define PTRX_FXSENDAMOUNT_B     0x08000001
291
292 #define CVCF                    0x02            /* Current volume and filter cutoff register            */
293 #define CVCF_CURRENTVOL_MASK    0xffff0000      /* Current linear volume of specified channel           */
294 #define CVCF_CURRENTVOL         0x10100002
295 #define CVCF_CURRENTFILTER_MASK 0x0000ffff      /* Current filter cutoff frequency of specified channel */
296 #define CVCF_CURRENTFILTER      0x10000002
297
298 #define VTFT                    0x03            /* Volume target and filter cutoff target register      */
299 #define VTFT_VOLUMETARGET_MASK  0xffff0000      /* Volume target of specified channel                   */
300 #define VTFT_FILTERTARGET_MASK  0x0000ffff      /* Filter cutoff target of specified channel            */
301
302 #define Z1                      0x05            /* Filter delay memory 1 register                       */
303
304 #define Z2                      0x04            /* Filter delay memory 2 register                       */
305
306 #define PSST                    0x06            /* Send C amount and loop start address register        */
307 #define PSST_FXSENDAMOUNT_C_MASK 0xff000000     /* Linear level of channel output sent to FX send bus C */
308
309 #define PSST_FXSENDAMOUNT_C     0x08180006
310
311 #define PSST_LOOPSTARTADDR_MASK 0x00ffffff      /* Loop start address of the specified channel          */
312 #define PSST_LOOPSTARTADDR      0x18000006
313
314 #define DSL                     0x07            /* Send D amount and loop start address register        */
315 #define DSL_FXSENDAMOUNT_D_MASK 0xff000000      /* Linear level of channel output sent to FX send bus D */
316
317 #define DSL_FXSENDAMOUNT_D      0x08180007
318
319 #define DSL_LOOPENDADDR_MASK    0x00ffffff      /* Loop end address of the specified channel            */
320 #define DSL_LOOPENDADDR         0x18000007
321
322 #define CCCA                    0x08            /* Filter Q, interp. ROM, byte size, cur. addr register */
323 #define CCCA_RESONANCE          0xf0000000      /* Lowpass filter resonance (Q) height                  */
324 #define CCCA_INTERPROMMASK      0x0e000000      /* Selects passband of interpolation ROM                */
325                                                 /* 1 == full band, 7 == lowpass                         */
326                                                 /* ROM 0 is used when pitch shifting downward or less   */
327                                                 /* then 3 semitones upward.  Increasingly higher ROM    */
328                                                 /* numbers are used, typically in steps of 3 semitones, */
329                                                 /* as upward pitch shifting is performed.               */
330 #define CCCA_INTERPROM_0        0x00000000      /* Select interpolation ROM 0                           */
331 #define CCCA_INTERPROM_1        0x02000000      /* Select interpolation ROM 1                           */
332 #define CCCA_INTERPROM_2        0x04000000      /* Select interpolation ROM 2                           */
333 #define CCCA_INTERPROM_3        0x06000000      /* Select interpolation ROM 3                           */
334 #define CCCA_INTERPROM_4        0x08000000      /* Select interpolation ROM 4                           */
335 #define CCCA_INTERPROM_5        0x0a000000      /* Select interpolation ROM 5                           */
336 #define CCCA_INTERPROM_6        0x0c000000      /* Select interpolation ROM 6                           */
337 #define CCCA_INTERPROM_7        0x0e000000      /* Select interpolation ROM 7                           */
338 #define CCCA_8BITSELECT         0x01000000      /* 1 = Sound memory for this channel uses 8-bit samples */
339 #define CCCA_CURRADDR_MASK      0x00ffffff      /* Current address of the selected channel              */
340 #define CCCA_CURRADDR           0x18000008
341
342 #define CCR                     0x09            /* Cache control register                               */
343 #define CCR_CACHEINVALIDSIZE    0x07190009
344 #define CCR_CACHEINVALIDSIZE_MASK       0xfe000000      /* Number of invalid samples cache for this channel     */
345 #define CCR_CACHELOOPFLAG       0x01000000      /* 1 = Cache has a loop service pending                 */
346 #define CCR_INTERLEAVEDSAMPLES  0x00800000      /* 1 = A cache service will fetch interleaved samples   */
347 #define CCR_WORDSIZEDSAMPLES    0x00400000      /* 1 = A cache service will fetch word sized samples    */
348 #define CCR_READADDRESS         0x06100009
349 #define CCR_READADDRESS_MASK    0x003f0000      /* Location of cache just beyond current cache service  */
350 #define CCR_LOOPINVALSIZE       0x0000fe00      /* Number of invalid samples in cache prior to loop     */
351                                                 /* NOTE: This is valid only if CACHELOOPFLAG is set     */
352 #define CCR_LOOPFLAG            0x00000100      /* Set for a single sample period when a loop occurs    */
353 #define CCR_CACHELOOPADDRHI     0x000000ff      /* DSL_LOOPSTARTADDR's hi byte if CACHELOOPFLAG is set  */
354
355 #define CLP                     0x0a            /* Cache loop register (valid if CCR_CACHELOOPFLAG = 1) */
356                                                 /* NOTE: This register is normally not used             */
357 #define CLP_CACHELOOPADDR       0x0000ffff      /* Cache loop address (DSL_LOOPSTARTADDR [0..15])       */
358
359 #define FXRT                    0x0b            /* Effects send routing register                        */
360                                                 /* NOTE: It is illegal to assign the same routing to    */
361                                                 /* two effects sends.                                   */
362 #define FXRT_CHANNELA           0x000f0000      /* Effects send bus number for channel's effects send A */
363 #define FXRT_CHANNELB           0x00f00000      /* Effects send bus number for channel's effects send B */
364 #define FXRT_CHANNELC           0x0f000000      /* Effects send bus number for channel's effects send C */
365 #define FXRT_CHANNELD           0xf0000000      /* Effects send bus number for channel's effects send D */
366
367 #define MAPA                    0x0c            /* Cache map A                                          */
368
369 #define MAPB                    0x0d            /* Cache map B                                          */
370
371 #define MAP_PTE_MASK            0xffffe000      /* The 19 MSBs of the PTE indexed by the PTI            */
372 #define MAP_PTI_MASK            0x00001fff      /* The 13 bit index to one of the 8192 PTE dwords       */
373
374 #define ENVVOL                  0x10            /* Volume envelope register                             */
375 #define ENVVOL_MASK             0x0000ffff      /* Current value of volume envelope state variable      */
376                                                 /* 0x8000-n == 666*n usec delay                         */
377
378 #define ATKHLDV                 0x11            /* Volume envelope hold and attack register             */
379 #define ATKHLDV_PHASE0          0x00008000      /* 0 = Begin attack phase                               */
380 #define ATKHLDV_HOLDTIME_MASK   0x00007f00      /* Envelope hold time (127-n == n*88.2msec)             */
381 #define ATKHLDV_ATTACKTIME_MASK 0x0000007f      /* Envelope attack time, log encoded                    */
382                                                 /* 0 = infinite, 1 = 10.9msec, ... 0x7f = 5.5msec       */
383
384 #define DCYSUSV                 0x12            /* Volume envelope sustain and decay register           */
385 #define DCYSUSV_PHASE1_MASK     0x00008000      /* 0 = Begin attack phase, 1 = begin release phase      */
386 #define DCYSUSV_SUSTAINLEVEL_MASK 0x00007f00    /* 127 = full, 0 = off, 0.75dB increments               */
387 #define DCYSUSV_CHANNELENABLE_MASK 0x00000080   /* 1 = Inhibit envelope engine from writing values in   */
388                                                 /* this channel and from writing to pitch, filter and   */
389                                                 /* volume targets.                                      */
390 #define DCYSUSV_DECAYTIME_MASK  0x0000007f      /* Volume envelope decay time, log encoded              */
391                                                 /* 0 = 43.7msec, 1 = 21.8msec, 0x7f = 22msec            */
392
393 #define LFOVAL1                 0x13            /* Modulation LFO value                                 */
394 #define LFOVAL_MASK             0x0000ffff      /* Current value of modulation LFO state variable       */
395                                                 /* 0x8000-n == 666*n usec delay                         */
396
397 #define ENVVAL                  0x14            /* Modulation envelope register                         */
398 #define ENVVAL_MASK             0x0000ffff      /* Current value of modulation envelope state variable  */
399                                                 /* 0x8000-n == 666*n usec delay                         */
400
401 #define ATKHLDM                 0x15            /* Modulation envelope hold and attack register         */
402 #define ATKHLDM_PHASE0          0x00008000      /* 0 = Begin attack phase                               */
403 #define ATKHLDM_HOLDTIME        0x00007f00      /* Envelope hold time (127-n == n*42msec)               */
404 #define ATKHLDM_ATTACKTIME      0x0000007f      /* Envelope attack time, log encoded                    */
405                                                 /* 0 = infinite, 1 = 11msec, ... 0x7f = 5.5msec         */
406
407 #define DCYSUSM                 0x16            /* Modulation envelope decay and sustain register       */
408 #define DCYSUSM_PHASE1_MASK     0x00008000      /* 0 = Begin attack phase, 1 = begin release phase      */
409 #define DCYSUSM_SUSTAINLEVEL_MASK 0x00007f00    /* 127 = full, 0 = off, 0.75dB increments               */
410 #define DCYSUSM_DECAYTIME_MASK  0x0000007f      /* Envelope decay time, log encoded                     */
411                                                 /* 0 = 43.7msec, 1 = 21.8msec, 0x7f = 22msec            */
412
413 #define LFOVAL2                 0x17            /* Vibrato LFO register                                 */
414 #define LFOVAL2_MASK            0x0000ffff      /* Current value of vibrato LFO state variable          */
415                                                 /* 0x8000-n == 666*n usec delay                         */
416
417 #define IP                      0x18            /* Initial pitch register                               */
418 #define IP_MASK                 0x0000ffff      /* Exponential initial pitch shift                      */
419                                                 /* 4 bits of octave, 12 bits of fractional octave       */
420 #define IP_UNITY                0x0000e000      /* Unity pitch shift                                    */
421
422 #define IFATN                   0x19            /* Initial filter cutoff and attenuation register       */
423 #define IFATN_FILTERCUTOFF_MASK 0x0000ff00      /* Initial filter cutoff frequency in exponential units */
424                                                 /* 6 most significant bits are semitones                */
425                                                 /* 2 least significant bits are fractions               */
426 #define IFATN_FILTERCUTOFF      0x08080019
427 #define IFATN_ATTENUATION_MASK  0x000000ff      /* Initial attenuation in 0.375dB steps                 */
428 #define IFATN_ATTENUATION       0x08000019
429
430
431 #define PEFE                    0x1a            /* Pitch envelope and filter envelope amount register   */
432 #define PEFE_PITCHAMOUNT_MASK   0x0000ff00      /* Pitch envlope amount                                 */
433                                                 /* Signed 2's complement, +/- one octave peak extremes  */
434 #define PEFE_PITCHAMOUNT        0x0808001a
435 #define PEFE_FILTERAMOUNT_MASK  0x000000ff      /* Filter envlope amount                                */
436                                                 /* Signed 2's complement, +/- six octaves peak extremes */
437 #define PEFE_FILTERAMOUNT       0x0800001a
438 #define FMMOD                   0x1b            /* Vibrato/filter modulation from LFO register          */
439 #define FMMOD_MODVIBRATO        0x0000ff00      /* Vibrato LFO modulation depth                         */
440                                                 /* Signed 2's complement, +/- one octave extremes       */
441 #define FMMOD_MOFILTER          0x000000ff      /* Filter LFO modulation depth                          */
442                                                 /* Signed 2's complement, +/- three octave extremes     */
443
444
445 #define TREMFRQ                 0x1c            /* Tremolo amount and modulation LFO frequency register */
446 #define TREMFRQ_DEPTH           0x0000ff00      /* Tremolo depth                                        */
447                                                 /* Signed 2's complement, with +/- 12dB extremes        */
448
449 #define FM2FRQ2                 0x1d            /* Vibrato amount and vibrato LFO frequency register    */
450 #define FM2FRQ2_DEPTH           0x0000ff00      /* Vibrato LFO vibrato depth                            */
451                                                 /* Signed 2's complement, +/- one octave extremes       */
452 #define FM2FRQ2_FREQUENCY       0x000000ff      /* Vibrato LFO frequency                                */
453                                                 /* 0.039Hz steps, maximum of 9.85 Hz.                   */
454
455 #define TEMPENV                 0x1e            /* Tempory envelope register                            */
456 #define TEMPENV_MASK            0x0000ffff      /* 16-bit value                                         */
457                                                 /* NOTE: All channels contain internal variables; do    */
458                                                 /* not write to these locations.                        */
459
460 #define CD0                     0x20            /* Cache data 0 register                                */
461 #define CD1                     0x21            /* Cache data 1 register                                */
462 #define CD2                     0x22            /* Cache data 2 register                                */
463 #define CD3                     0x23            /* Cache data 3 register                                */
464 #define CD4                     0x24            /* Cache data 4 register                                */
465 #define CD5                     0x25            /* Cache data 5 register                                */
466 #define CD6                     0x26            /* Cache data 6 register                                */
467 #define CD7                     0x27            /* Cache data 7 register                                */
468 #define CD8                     0x28            /* Cache data 8 register                                */
469 #define CD9                     0x29            /* Cache data 9 register                                */
470 #define CDA                     0x2a            /* Cache data A register                                */
471 #define CDB                     0x2b            /* Cache data B register                                */
472 #define CDC                     0x2c            /* Cache data C register                                */
473 #define CDD                     0x2d            /* Cache data D register                                */
474 #define CDE                     0x2e            /* Cache data E register                                */
475 #define CDF                     0x2f            /* Cache data F register                                */
476
477 #define PTB                     0x40            /* Page table base register                             */
478 #define PTB_MASK                0xfffff000      /* Physical address of the page table in host memory    */
479
480 #define TCB                     0x41            /* Tank cache base register                             */
481 #define TCB_MASK                0xfffff000      /* Physical address of the bottom of host based TRAM    */
482
483 #define ADCCR                   0x42            /* ADC sample rate/stereo control register              */
484 #define ADCCR_RCHANENABLE       0x00000010      /* Enables right channel for writing to the host        */
485 #define ADCCR_LCHANENABLE       0x00000008      /* Enables left channel for writing to the host         */
486                                                 /* NOTE: To guarantee phase coherency, both channels    */
487                                                 /* must be disabled prior to enabling both channels.    */
488 #define ADCCR_SAMPLERATE_MASK   0x00000007      /* Sample rate convertor output rate                    */
489 #define ADCCR_SAMPLERATE_48     0x00000000      /* 48kHz sample rate                                    */
490 #define ADCCR_SAMPLERATE_44     0x00000001      /* 44.1kHz sample rate                                  */
491 #define ADCCR_SAMPLERATE_32     0x00000002      /* 32kHz sample rate                                    */
492 #define ADCCR_SAMPLERATE_24     0x00000003      /* 24kHz sample rate                                    */
493 #define ADCCR_SAMPLERATE_22     0x00000004      /* 22.05kHz sample rate                                 */
494 #define ADCCR_SAMPLERATE_16     0x00000005      /* 16kHz sample rate                                    */
495 #define ADCCR_SAMPLERATE_11     0x00000006      /* 11.025kHz sample rate                                */
496 #define ADCCR_SAMPLERATE_8      0x00000007      /* 8kHz sample rate                                     */
497
498 #define FXWC                    0x43            /* FX output write channels register                    */
499                                                 /* When set, each bit enables the writing of the        */
500                                                 /* corresponding FX output channel into host memory     */
501
502 #define TCBS                    0x44            /* Tank cache buffer size register                      */
503 #define TCBS_MASK               0x00000007      /* Tank cache buffer size field                         */
504 #define TCBS_BUFFSIZE_16K       0x00000000
505 #define TCBS_BUFFSIZE_32K       0x00000001
506 #define TCBS_BUFFSIZE_64K       0x00000002
507 #define TCBS_BUFFSIZE_128K      0x00000003
508 #define TCBS_BUFFSIZE_256K      0x00000004
509 #define TCBS_BUFFSIZE_512K      0x00000005
510 #define TCBS_BUFFSIZE_1024K     0x00000006
511 #define TCBS_BUFFSIZE_2048K     0x00000007
512
513 #define MICBA                   0x45            /* AC97 microphone buffer address register              */
514 #define MICBA_MASK              0xfffff000      /* 20 bit base address                                  */
515
516 #define ADCBA                   0x46            /* ADC buffer address register                          */
517 #define ADCBA_MASK              0xfffff000      /* 20 bit base address                                  */
518
519 #define FXBA                    0x47            /* FX Buffer Address */
520 #define FXBA_MASK               0xfffff000      /* 20 bit base address                                  */
521
522 #define MICBS                   0x49            /* Microphone buffer size register                      */
523
524 #define ADCBS                   0x4a            /* ADC buffer size register                             */
525
526 #define FXBS                    0x4b            /* FX buffer size register                              */
527
528 /* The following mask values define the size of the ADC, MIX and FX buffers in bytes */
529 #define ADCBS_BUFSIZE_NONE      0x00000000
530 #define ADCBS_BUFSIZE_384       0x00000001
531 #define ADCBS_BUFSIZE_448       0x00000002
532 #define ADCBS_BUFSIZE_512       0x00000003
533 #define ADCBS_BUFSIZE_640       0x00000004
534 #define ADCBS_BUFSIZE_768       0x00000005
535 #define ADCBS_BUFSIZE_896       0x00000006
536 #define ADCBS_BUFSIZE_1024      0x00000007
537 #define ADCBS_BUFSIZE_1280      0x00000008
538 #define ADCBS_BUFSIZE_1536      0x00000009
539 #define ADCBS_BUFSIZE_1792      0x0000000a
540 #define ADCBS_BUFSIZE_2048      0x0000000b
541 #define ADCBS_BUFSIZE_2560      0x0000000c
542 #define ADCBS_BUFSIZE_3072      0x0000000d
543 #define ADCBS_BUFSIZE_3584      0x0000000e
544 #define ADCBS_BUFSIZE_4096      0x0000000f
545 #define ADCBS_BUFSIZE_5120      0x00000010
546 #define ADCBS_BUFSIZE_6144      0x00000011
547 #define ADCBS_BUFSIZE_7168      0x00000012
548 #define ADCBS_BUFSIZE_8192      0x00000013
549 #define ADCBS_BUFSIZE_10240     0x00000014
550 #define ADCBS_BUFSIZE_12288     0x00000015
551 #define ADCBS_BUFSIZE_14366     0x00000016
552 #define ADCBS_BUFSIZE_16384     0x00000017
553 #define ADCBS_BUFSIZE_20480     0x00000018
554 #define ADCBS_BUFSIZE_24576     0x00000019
555 #define ADCBS_BUFSIZE_28672     0x0000001a
556 #define ADCBS_BUFSIZE_32768     0x0000001b
557 #define ADCBS_BUFSIZE_40960     0x0000001c
558 #define ADCBS_BUFSIZE_49152     0x0000001d
559 #define ADCBS_BUFSIZE_57344     0x0000001e
560 #define ADCBS_BUFSIZE_65536     0x0000001f
561
562
563 #define CDCS                    0x50            /* CD-ROM digital channel status register       */
564
565 #define GPSCS                   0x51            /* General Purpose SPDIF channel status register*/
566
567 #define DBG                     0x52            /* DO NOT PROGRAM THIS REGISTER!!! MAY DESTROY CHIP */
568
569 #define REG53                   0x53            /* DO NOT PROGRAM THIS REGISTER!!! MAY DESTROY CHIP */
570
571 #define SPCS0                   0x54            /* SPDIF output Channel Status 0 register       */
572
573 #define SPCS1                   0x55            /* SPDIF output Channel Status 1 register       */
574
575 #define SPCS2                   0x56            /* SPDIF output Channel Status 2 register       */
576
577 #define SPCS_CLKACCYMASK        0x30000000      /* Clock accuracy                               */
578 #define SPCS_CLKACCY_1000PPM    0x00000000      /* 1000 parts per million                       */
579 #define SPCS_CLKACCY_50PPM      0x10000000      /* 50 parts per million                         */
580 #define SPCS_CLKACCY_VARIABLE   0x20000000      /* Variable accuracy                            */
581 #define SPCS_SAMPLERATEMASK     0x0f000000      /* Sample rate                                  */
582 #define SPCS_SAMPLERATE_44      0x00000000      /* 44.1kHz sample rate                          */
583 #define SPCS_SAMPLERATE_48      0x02000000      /* 48kHz sample rate                            */
584 #define SPCS_SAMPLERATE_32      0x03000000      /* 32kHz sample rate                            */
585 #define SPCS_CHANNELNUMMASK     0x00f00000      /* Channel number                               */
586 #define SPCS_CHANNELNUM_UNSPEC  0x00000000      /* Unspecified channel number                   */
587 #define SPCS_CHANNELNUM_LEFT    0x00100000      /* Left channel                                 */
588 #define SPCS_CHANNELNUM_RIGHT   0x00200000      /* Right channel                                */
589 #define SPCS_SOURCENUMMASK      0x000f0000      /* Source number                                */
590 #define SPCS_SOURCENUM_UNSPEC   0x00000000      /* Unspecified source number                    */
591 #define SPCS_GENERATIONSTATUS   0x00008000      /* Originality flag (see IEC-958 spec)          */
592 #define SPCS_CATEGORYCODEMASK   0x00007f00      /* Category code (see IEC-958 spec)             */
593 #define SPCS_MODEMASK           0x000000c0      /* Mode (see IEC-958 spec)                      */
594 #define SPCS_EMPHASISMASK       0x00000038      /* Emphasis                                     */
595 #define SPCS_EMPHASIS_NONE      0x00000000      /* No emphasis                                  */
596 #define SPCS_EMPHASIS_50_15     0x00000008      /* 50/15 usec 2 channel                         */
597 #define SPCS_COPYRIGHT          0x00000004      /* Copyright asserted flag -- do not modify     */
598 #define SPCS_NOTAUDIODATA       0x00000002      /* 0 = Digital audio, 1 = not audio             */
599 #define SPCS_PROFESSIONAL       0x00000001      /* 0 = Consumer (IEC-958), 1 = pro (AES3-1992)  */
600
601 /* The 32-bit CLIx and SOLx registers all have one bit per channel control/status               */
602 #define CLIEL                   0x58            /* Channel loop interrupt enable low register   */
603
604 #define CLIEH                   0x59            /* Channel loop interrupt enable high register  */
605
606 #define CLIPL                   0x5a            /* Channel loop interrupt pending low register  */
607
608 #define CLIPH                   0x5b            /* Channel loop interrupt pending high register */
609
610 #define SOLEL                   0x5c            /* Stop on loop enable low register             */
611
612 #define SOLEH                   0x5d            /* Stop on loop enable high register            */
613
614 #define SPBYPASS                0x5e            /* SPDIF BYPASS mode register                   */
615 #define SPBYPASS_ENABLE         0x00000001      /* Enable SPDIF bypass mode                     */
616
617 #define CDSRCS                  0x60            /* CD-ROM Sample Rate Converter status register */
618
619 #define GPSRCS                  0x61            /* General Purpose SPDIF sample rate cvt status */
620
621 #define ZVSRCS                  0x62            /* ZVideo sample rate converter status          */
622                                                 /* NOTE: This one has no SPDIFLOCKED field      */
623                                                 /* Assumes sample lock                          */
624
625 /* These three bitfields apply to CDSRCS, GPSRCS, and (except as noted) ZVSRCS.                 */
626 #define SRCS_SPDIFLOCKED        0x02000000      /* SPDIF stream locked                          */
627 #define SRCS_RATELOCKED         0x01000000      /* Sample rate locked                           */
628 #define SRCS_ESTSAMPLERATE      0x0007ffff      /* Do not modify this field.                    */
629
630 #define MICIDX                  0x63            /* Microphone recording buffer index register   */
631 #define MICIDX_MASK             0x0000ffff      /* 16-bit value                                 */
632 #define MICIDX_IDX              0x10000063
633
634 #define ADCIDX                  0x64            /* ADC recording buffer index register          */
635 #define ADCIDX_MASK             0x0000ffff      /* 16 bit index field                           */
636 #define ADCIDX_IDX              0x10000064
637
638 #define FXIDX                   0x65            /* FX recording buffer index register           */
639 #define FXIDX_MASK              0x0000ffff      /* 16-bit value                                 */
640 #define FXIDX_IDX               0x10000065
641
642 /* Each FX general purpose register is 32 bits in length, all bits are used                     */
643 #define FXGPREGBASE             0x100           /* FX general purpose registers base            */
644
645 /* Tank audio data is logarithmically compressed down to 16 bits before writing to TRAM and is  */
646 /* decompressed back to 20 bits on a read.  There are a total of 160 locations, the last 32     */
647 /* locations are for external TRAM.                                                             */
648 #define TANKMEMDATAREGBASE      0x200           /* Tank memory data registers base              */
649 #define TANKMEMDATAREG_MASK     0x000fffff      /* 20 bit tank audio data field                 */
650
651 /* Combined address field and memory opcode or flag field.  160 locations, last 32 are external */
652 #define TANKMEMADDRREGBASE      0x300           /* Tank memory address registers base           */
653 #define TANKMEMADDRREG_ADDR_MASK 0x000fffff     /* 20 bit tank address field                    */
654 #define TANKMEMADDRREG_CLEAR    0x00800000      /* Clear tank memory                            */
655 #define TANKMEMADDRREG_ALIGN    0x00400000      /* Align read or write relative to tank access  */
656 #define TANKMEMADDRREG_WRITE    0x00200000      /* Write to tank memory                         */
657 #define TANKMEMADDRREG_READ     0x00100000      /* Read from tank memory                        */
658
659 #define MICROCODEBASE           0x400           /* Microcode data base address                  */
660
661 /* Each DSP microcode instruction is mapped into 2 doublewords                                  */
662 /* NOTE: When writing, always write the LO doubleword first.  Reads can be in either order.     */
663 #define LOWORD_OPX_MASK         0x000ffc00      /* Instruction operand X                        */
664 #define LOWORD_OPY_MASK         0x000003ff      /* Instruction operand Y                        */
665 #define HIWORD_OPCODE_MASK      0x00f00000      /* Instruction opcode                           */
666 #define HIWORD_RESULT_MASK      0x000ffc00      /* Instruction result                           */
667 #define HIWORD_OPA_MASK         0x000003ff      /* Instruction operand A                        */
668
669 #define ENABLE                  0xffffffff
670 #define DISABLE                 0x00000000
671
672 #define ENV_ON                  0x80
673 #define ENV_OFF                 0x00
674
675 #endif /* EMU10K1_H */