Add linux-next specific files for 20110716
[linux-2.6/next.git] / sound / oss / msnd.h
blobc8be47ec2b7ea25c1a5aa722f44458445a5e7d83
1 /*********************************************************************
3 * msnd.h
5 * Turtle Beach MultiSound Sound Card Driver for Linux
7 * Some parts of this header file were derived from the Turtle Beach
8 * MultiSound Driver Development Kit.
10 * Copyright (C) 1998 Andrew Veliath
11 * Copyright (C) 1993 Turtle Beach Systems, Inc.
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 ********************************************************************/
28 #ifndef __MSND_H
29 #define __MSND_H
31 #define VERSION "0.8.3.1"
33 #define DEFSAMPLERATE DSP_DEFAULT_SPEED
34 #define DEFSAMPLESIZE AFMT_U8
35 #define DEFCHANNELS 1
37 #define DEFFIFOSIZE 128
39 #define SNDCARD_MSND 38
41 #define SRAM_BANK_SIZE 0x8000
42 #define SRAM_CNTL_START 0x7F00
44 #define DSP_BASE_ADDR 0x4000
45 #define DSP_BANK_BASE 0x4000
47 #define HP_ICR 0x00
48 #define HP_CVR 0x01
49 #define HP_ISR 0x02
50 #define HP_IVR 0x03
51 #define HP_NU 0x04
52 #define HP_INFO 0x04
53 #define HP_TXH 0x05
54 #define HP_RXH 0x05
55 #define HP_TXM 0x06
56 #define HP_RXM 0x06
57 #define HP_TXL 0x07
58 #define HP_RXL 0x07
60 #define HP_ICR_DEF 0x00
61 #define HP_CVR_DEF 0x12
62 #define HP_ISR_DEF 0x06
63 #define HP_IVR_DEF 0x0f
64 #define HP_NU_DEF 0x00
66 #define HP_IRQM 0x09
68 #define HPR_BLRC 0x08
69 #define HPR_SPR1 0x09
70 #define HPR_SPR2 0x0A
71 #define HPR_TCL0 0x0B
72 #define HPR_TCL1 0x0C
73 #define HPR_TCL2 0x0D
74 #define HPR_TCL3 0x0E
75 #define HPR_TCL4 0x0F
77 #define HPICR_INIT 0x80
78 #define HPICR_HM1 0x40
79 #define HPICR_HM0 0x20
80 #define HPICR_HF1 0x10
81 #define HPICR_HF0 0x08
82 #define HPICR_TREQ 0x02
83 #define HPICR_RREQ 0x01
85 #define HPCVR_HC 0x80
87 #define HPISR_HREQ 0x80
88 #define HPISR_DMA 0x40
89 #define HPISR_HF3 0x10
90 #define HPISR_HF2 0x08
91 #define HPISR_TRDY 0x04
92 #define HPISR_TXDE 0x02
93 #define HPISR_RXDF 0x01
95 #define HPIO_290 0
96 #define HPIO_260 1
97 #define HPIO_250 2
98 #define HPIO_240 3
99 #define HPIO_230 4
100 #define HPIO_220 5
101 #define HPIO_210 6
102 #define HPIO_3E0 7
104 #define HPMEM_NONE 0
105 #define HPMEM_B000 1
106 #define HPMEM_C800 2
107 #define HPMEM_D000 3
108 #define HPMEM_D400 4
109 #define HPMEM_D800 5
110 #define HPMEM_E000 6
111 #define HPMEM_E800 7
113 #define HPIRQ_NONE 0
114 #define HPIRQ_5 1
115 #define HPIRQ_7 2
116 #define HPIRQ_9 3
117 #define HPIRQ_10 4
118 #define HPIRQ_11 5
119 #define HPIRQ_12 6
120 #define HPIRQ_15 7
122 #define HIMT_PLAY_DONE 0x00
123 #define HIMT_RECORD_DONE 0x01
124 #define HIMT_MIDI_EOS 0x02
125 #define HIMT_MIDI_OUT 0x03
127 #define HIMT_MIDI_IN_UCHAR 0x0E
128 #define HIMT_DSP 0x0F
130 #define HDEX_BASE 0x92
131 #define HDEX_PLAY_START (0 + HDEX_BASE)
132 #define HDEX_PLAY_STOP (1 + HDEX_BASE)
133 #define HDEX_PLAY_PAUSE (2 + HDEX_BASE)
134 #define HDEX_PLAY_RESUME (3 + HDEX_BASE)
135 #define HDEX_RECORD_START (4 + HDEX_BASE)
136 #define HDEX_RECORD_STOP (5 + HDEX_BASE)
137 #define HDEX_MIDI_IN_START (6 + HDEX_BASE)
138 #define HDEX_MIDI_IN_STOP (7 + HDEX_BASE)
139 #define HDEX_MIDI_OUT_START (8 + HDEX_BASE)
140 #define HDEX_MIDI_OUT_STOP (9 + HDEX_BASE)
141 #define HDEX_AUX_REQ (10 + HDEX_BASE)
143 #define HIWORD(l) ((WORD)((((DWORD)(l)) >> 16) & 0xFFFF))
144 #define LOWORD(l) ((WORD)(DWORD)(l))
145 #define HIBYTE(w) ((BYTE)(((WORD)(w) >> 8) & 0xFF))
146 #define LOBYTE(w) ((BYTE)(w))
147 #define MAKELONG(low,hi) ((long)(((WORD)(low))|(((DWORD)((WORD)(hi)))<<16)))
148 #define MAKEWORD(low,hi) ((WORD)(((BYTE)(low))|(((WORD)((BYTE)(hi)))<<8)))
150 #define PCTODSP_OFFSET(w) (USHORT)((w)/2)
151 #define PCTODSP_BASED(w) (USHORT)(((w)/2) + DSP_BASE_ADDR)
152 #define DSPTOPC_BASED(w) (((w) - DSP_BASE_ADDR) * 2)
154 #ifdef SLOWIO
155 #define msnd_outb outb_p
156 #define msnd_inb inb_p
157 #else
158 #define msnd_outb outb
159 #define msnd_inb inb
160 #endif
162 /* JobQueueStruct */
163 #define JQS_wStart 0x00
164 #define JQS_wSize 0x02
165 #define JQS_wHead 0x04
166 #define JQS_wTail 0x06
167 #define JQS__size 0x08
169 /* DAQueueDataStruct */
170 #define DAQDS_wStart 0x00
171 #define DAQDS_wSize 0x02
172 #define DAQDS_wFormat 0x04
173 #define DAQDS_wSampleSize 0x06
174 #define DAQDS_wChannels 0x08
175 #define DAQDS_wSampleRate 0x0A
176 #define DAQDS_wIntMsg 0x0C
177 #define DAQDS_wFlags 0x0E
178 #define DAQDS__size 0x10
180 typedef u8 BYTE;
181 typedef u16 USHORT;
182 typedef u16 WORD;
183 typedef u32 DWORD;
184 typedef void __iomem * LPDAQD;
186 /* Generic FIFO */
187 typedef struct {
188 size_t n, len;
189 char *data;
190 int head, tail;
191 } msnd_fifo;
193 typedef struct multisound_dev {
194 /* Linux device info */
195 char *name;
196 int dsp_minor, mixer_minor;
197 int ext_midi_dev, hdr_midi_dev;
199 /* Hardware resources */
200 int io, numio;
201 int memid, irqid;
202 int irq, irq_ref;
203 unsigned char info;
204 void __iomem *base;
206 /* Motorola 56k DSP SMA */
207 void __iomem *SMA;
208 void __iomem *DAPQ, *DARQ, *MODQ, *MIDQ, *DSPQ;
209 void __iomem *pwDSPQData, *pwMIDQData, *pwMODQData;
210 int dspq_data_buff, dspq_buff_size;
212 /* State variables */
213 enum { msndClassic, msndPinnacle } type;
214 fmode_t mode;
215 unsigned long flags;
216 #define F_RESETTING 0
217 #define F_HAVEDIGITAL 1
218 #define F_AUDIO_WRITE_INUSE 2
219 #define F_WRITING 3
220 #define F_WRITEBLOCK 4
221 #define F_WRITEFLUSH 5
222 #define F_AUDIO_READ_INUSE 6
223 #define F_READING 7
224 #define F_READBLOCK 8
225 #define F_EXT_MIDI_INUSE 9
226 #define F_HDR_MIDI_INUSE 10
227 #define F_DISABLE_WRITE_NDELAY 11
228 wait_queue_head_t writeblock;
229 wait_queue_head_t readblock;
230 wait_queue_head_t writeflush;
231 spinlock_t lock;
232 int nresets;
233 unsigned long recsrc;
234 int left_levels[32];
235 int right_levels[32];
236 int mixer_mod_count;
237 int calibrate_signal;
238 int play_sample_size, play_sample_rate, play_channels;
239 int play_ndelay;
240 int rec_sample_size, rec_sample_rate, rec_channels;
241 int rec_ndelay;
242 BYTE bCurrentMidiPatch;
244 /* Digital audio FIFOs */
245 msnd_fifo DAPF, DARF;
246 int fifosize;
247 int last_playbank, last_recbank;
249 /* MIDI in callback */
250 void (*midi_in_interrupt)(struct multisound_dev *);
251 } multisound_dev_t;
253 #ifndef mdelay
254 # define mdelay(a) udelay((a) * 1000)
255 #endif
257 int msnd_register(multisound_dev_t *dev);
258 void msnd_unregister(multisound_dev_t *dev);
260 void msnd_init_queue(void __iomem *, int start, int size);
262 void msnd_fifo_init(msnd_fifo *f);
263 void msnd_fifo_free(msnd_fifo *f);
264 int msnd_fifo_alloc(msnd_fifo *f, size_t n);
265 void msnd_fifo_make_empty(msnd_fifo *f);
266 int msnd_fifo_write_io(msnd_fifo *f, char __iomem *buf, size_t len);
267 int msnd_fifo_read_io(msnd_fifo *f, char __iomem *buf, size_t len);
268 int msnd_fifo_write(msnd_fifo *f, const char *buf, size_t len);
269 int msnd_fifo_read(msnd_fifo *f, char *buf, size_t len);
271 int msnd_send_dsp_cmd(multisound_dev_t *dev, BYTE cmd);
272 int msnd_send_word(multisound_dev_t *dev, unsigned char high,
273 unsigned char mid, unsigned char low);
274 int msnd_upload_host(multisound_dev_t *dev, char *bin, int len);
275 int msnd_enable_irq(multisound_dev_t *dev);
276 int msnd_disable_irq(multisound_dev_t *dev);
278 #endif /* __MSND_H */