xref: /freebsd/sys/sys/soundcard.h (revision a8445737e740901f5f2c8d24c12ef7fc8b00134e)
1 /*
2  * soundcard.h
3  *
4  * Copyright by Hannu Savolainen 1993
5  * Modified for the new FreeBSD sound driver by Luigi Rizzo, 1997
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above
13  *    copyright notice, this list of conditions and the following
14  *    disclaimer in the documentation and/or other materials provided
15  *    with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef SOUNDCARD_H
32 #define SOUNDCARD_H
33  /*
34   * If you make modifications to this file, please contact me before
35   * distributing the modified version. There is already enough
36   * diversity in the world.
37   *
38   * Regards,
39   * Hannu Savolainen
40   * hannu@voxware.pp.fi
41   *
42   **********************************************************************
43   * PS.	The Hacker's Guide to VoxWare available from
44   *     nic.funet.fi:pub/OS/Linux/ALPHA/sound. The file is
45   *	snd-sdk-doc-0.1.ps.gz (gzipped postscript). It contains
46   *	some useful information about programming with VoxWare.
47   *	(NOTE! The pub/OS/Linux/ALPHA/ directories are hidden. You have
48   *	to cd inside them before the files are accessible.)
49   **********************************************************************
50   */
51 
52 /*
53  * SOUND_VERSION is only used by the voxware driver. Hopefully apps
54  * should not depend on it, but rather look at the capabilities
55  * of the driver in the kernel!
56  */
57 #define SOUND_VERSION  301
58 #define VOXWARE		/* does this have any use ? */
59 
60 /*
61  * Supported card ID numbers (Should be somewhere else? We keep
62  * them here just for compativility with the old driver, but these
63  * constants are of little or no use).
64  */
65 
66 #define SNDCARD_ADLIB          1
67 #define SNDCARD_SB             2
68 #define SNDCARD_PAS            3
69 #define SNDCARD_GUS            4
70 #define SNDCARD_MPU401         5
71 #define SNDCARD_SB16           6
72 #define SNDCARD_SB16MIDI       7
73 #define SNDCARD_UART6850       8
74 #define SNDCARD_GUS16          9
75 #define SNDCARD_MSS            10
76 #define SNDCARD_PSS            11
77 #define SNDCARD_SSCAPE         12
78 #define SNDCARD_PSS_MPU        13
79 #define SNDCARD_PSS_MSS        14
80 #define SNDCARD_SSCAPE_MSS     15
81 #define SNDCARD_TRXPRO         16
82 #define SNDCARD_TRXPRO_SB      17
83 #define SNDCARD_TRXPRO_MPU     18
84 #define SNDCARD_MAD16          19
85 #define SNDCARD_MAD16_MPU      20
86 #define SNDCARD_CS4232         21
87 #define SNDCARD_CS4232_MPU     22
88 #define SNDCARD_MAUI           23
89 #define SNDCARD_PSEUDO_MSS     24
90 #define SNDCARD_AWE32           25
91 
92 #include <sys/types.h>
93 #ifndef _IOWR
94 #include <sys/ioccom.h>
95 #endif  /* !_IOWR */
96 
97 /*
98  * The first part of this file contains the new FreeBSD sound ioctl
99  * interface. Tries to minimize the number of different ioctls, and
100  * to be reasonably general.
101  *
102  * 970821: some of the new calls have not been implemented yet.
103  */
104 
105 /*
106  * the following three calls extend the generic file descriptor
107  * interface. AIONWRITE is the dual of FIONREAD, i.e. returns the max
108  * number of bytes for a write operation to be non-blocking.
109  *
110  * AIOGSIZE/AIOSSIZE are used to change the behaviour of the device,
111  * from a character device (default) to a block device. In block mode,
112  * (not to be confused with blocking mode) the main difference for the
113  * application is that select() will return only when a complete
114  * block can be read/written to the device, whereas in character mode
115  * select will return true when one byte can be exchanged. For audio
116  * devices, character mode makes select almost useless since one byte
117  * will always be ready by the next sample time (which is often only a
118  * handful of microseconds away).
119  * Use a size of 0 or 1 to return to character mode.
120  */
121 #define	AIONWRITE   _IOR('A', 10, int)   /* get # bytes to write */
122 struct snd_size {
123     int play_size;
124     int rec_size;
125 };
126 #define	AIOGSIZE    _IOR('A', 11, struct snd_size)/* read current blocksize */
127 #define	AIOSSIZE    _IOWR('A', 11, struct snd_size)  /* sets blocksize */
128 
129 /*
130  * The following constants define supported audio formats. The
131  * encoding follows voxware conventions, i.e. 1 bit for each supported
132  * format. We extend it by using bit 31 (RO) to indicate full-duplex
133  * capability, and bit 29 (RO) to indicate that the card supports/
134  * needs different formats on capture & playback channels.
135  * Bit 29 (RW) is used to indicate/ask stereo.
136  */
137 
138 #   define AFMT_QUERY		0x00000000	/* Return current fmt */
139 #   define AFMT_MU_LAW		0x00000001
140 #   define AFMT_A_LAW		0x00000002
141 #   define AFMT_IMA_ADPCM	0x00000004
142 #   define AFMT_U8		0x00000008
143 #   define AFMT_S16_LE		0x00000010	/* Little endian signed 16*/
144 #   define AFMT_S16_BE		0x00000020	/* Big endian signed 16 */
145 #   define AFMT_S8		0x00000040
146 #   define AFMT_U16_LE		0x00000080	/* Little endian U16 */
147 #   define AFMT_U16_BE		0x00000100	/* Big endian U16 */
148 #   define AFMT_MPEG		0x00000200	/* MPEG (2) audio */
149 
150 #   define AFMT_STEREO		0x10000000	/* can do/want stereo	*/
151 
152 /*
153  * the following are really capabilities
154  */
155 #   define AFMT_WEIRD		0x20000000	/* weird hardware...	*/
156     /*
157      * AFMT_WEIRD reports that the hardware might need to operate
158      * with different formats in the playback and capture
159      * channels when operating in full duplex.
160      * As an example, SoundBlaster16 cards only support U8 in one
161      * direction and S16 in the other one, and applications should
162      * be aware of this limitation.
163      */
164 #   define AFMT_FULLDUPLEX	0x80000000	/* can do full duplex	*/
165 
166 /*
167  * The following structure is used to get/set format and sampling rate.
168  * While it would be better to have things such as stereo, bits per
169  * sample, endiannes, etc split in different variables, it turns out
170  * that formats are not that many, and not all combinations are possible.
171  * So we followed the Voxware approach of associating one bit to each
172  * format.
173  */
174 
175 typedef struct _snd_chan_param {
176     u_long	play_rate;	/* sampling rate			*/
177     u_long	rec_rate;	/* sampling rate			*/
178     u_long	play_format;	/* everything describing the format	*/
179     u_long	rec_format;	/* everything describing the format	*/
180 } snd_chan_param;
181 #define	AIOGFMT    _IOR('f', 12, snd_chan_param)   /* get format */
182 #define	AIOSFMT    _IOWR('f', 12, snd_chan_param)  /* sets format */
183 
184 /*
185  * The following structure is used to get/set the mixer setting.
186  * Up to 32 mixers are supported, each one with up to 32 channels.
187  */
188 typedef struct _snd_mix_param {
189     u_char	subdev;	/* which output				*/
190     u_char	line;	/* which input				*/
191     u_char	left,right; /* volumes, 0..255, 0 = mute	*/
192 } snd_mix_param ;
193 
194 /* XXX AIOGMIX, AIOSMIX not implemented yet */
195 #define AIOGMIX	_IOWR('A', 13, snd_mix_param)	/* return mixer status */
196 #define AIOSMIX	_IOWR('A', 14, snd_mix_param)	/* sets mixer status   */
197 
198 /*
199  * channel specifiers used in AIOSTOP and AIOSYNC
200  */
201 #define	AIOSYNC_PLAY	0x1	/* play chan */
202 #define	AIOSYNC_CAPTURE	0x2	/* capture chan */
203 /* AIOSTOP stop & flush a channel, returns the residual count */
204 #define	AIOSTOP	_IOWR ('A', 15, int)
205 
206 /* alternate method used to notify the sync condition */
207 #define	AIOSYNC_SIGNAL	0x100
208 #define	AIOSYNC_SELECT	0x200
209 
210 /* what the 'pos' field refers to */
211 #define AIOSYNC_READY	0x400
212 #define AIOSYNC_FREE	0x800
213 
214 typedef struct _snd_sync_parm {
215     long chan ; /* play or capture channel, plus modifier */
216     long pos;
217 } snd_sync_parm;
218 #define	AIOSYNC	_IOWR ('A', 15, snd_sync_parm)	/* misc. synchronization */
219 
220 /*
221  * The following is used to return device capabilities. If the structure
222  * passed to the ioctl is zeroed, default values are returned for rate
223  * and formats, a bitmap of available mixers is returned, and values
224  * (inputs, different levels) for the first one are returned.
225  *
226  * If  formats, mixers, inputs are instantiated, then detailed info
227  * are returned depending on the call.
228  */
229 typedef struct _snd_capabilities {
230     u_long	rate_min, rate_max;	/* min-max sampling rate */
231     u_long	formats;
232     u_long	bufsize; /* DMA buffer size */
233     u_long	mixers; /* bitmap of available mixers */
234     u_long	inputs; /* bitmap of available inputs (per mixer) */
235     u_short	left, right;	/* how many levels are supported */
236 } snd_capabilities;
237 #define AIOGCAP	_IOWR('A', 15, snd_capabilities)	/* get capabilities */
238 
239 /*
240  * here is the old (Voxware) ioctl interface
241  */
242 
243 /*
244  * IOCTL Commands for /dev/sequencer
245  */
246 
247 #define SNDCTL_SEQ_RESET	_IO  ('Q', 0)
248 #define SNDCTL_SEQ_SYNC		_IO  ('Q', 1)
249 #define SNDCTL_SYNTH_INFO	_IOWR('Q', 2, struct synth_info)
250 #define SNDCTL_SEQ_CTRLRATE	_IOWR('Q', 3, int) /* Set/get timer res.(hz) */
251 #define SNDCTL_SEQ_GETOUTCOUNT	_IOR ('Q', 4, int)
252 #define SNDCTL_SEQ_GETINCOUNT	_IOR ('Q', 5, int)
253 #define SNDCTL_SEQ_PERCMODE	_IOW ('Q', 6, int)
254 #define SNDCTL_FM_LOAD_INSTR	_IOW ('Q', 7, struct sbi_instrument)	/* Valid for FM only */
255 #define SNDCTL_SEQ_TESTMIDI	_IOW ('Q', 8, int)
256 #define SNDCTL_SEQ_RESETSAMPLES	_IOW ('Q', 9, int)
257 #define SNDCTL_SEQ_NRSYNTHS	_IOR ('Q',10, int)
258 #define SNDCTL_SEQ_NRMIDIS	_IOR ('Q',11, int)
259 #define SNDCTL_MIDI_INFO	_IOWR('Q',12, struct midi_info)
260 #define SNDCTL_SEQ_THRESHOLD	_IOW ('Q',13, int)
261 #define SNDCTL_SEQ_TRESHOLD	SNDCTL_SEQ_THRESHOLD	/* there was once a typo */
262 #define SNDCTL_SYNTH_MEMAVL	_IOWR('Q',14, int) /* in=dev#, out=memsize */
263 #define SNDCTL_FM_4OP_ENABLE	_IOW ('Q',15, int) /* in=dev# */
264 #define SNDCTL_PMGR_ACCESS	_IOWR('Q',16, struct patmgr_info)
265 #define SNDCTL_SEQ_PANIC	_IO  ('Q',17)
266 #define SNDCTL_SEQ_OUTOFBAND	_IOW ('Q',18, struct seq_event_rec)
267 
268 struct seq_event_rec {
269 	u_char arr[8];
270 };
271 
272 #define SNDCTL_TMR_TIMEBASE	_IOWR('T', 1, int)
273 #define SNDCTL_TMR_START	_IO  ('T', 2)
274 #define SNDCTL_TMR_STOP		_IO  ('T', 3)
275 #define SNDCTL_TMR_CONTINUE	_IO  ('T', 4)
276 #define SNDCTL_TMR_TEMPO	_IOWR('T', 5, int)
277 #define SNDCTL_TMR_SOURCE	_IOWR('T', 6, int)
278 #   define TMR_INTERNAL		0x00000001
279 #   define TMR_EXTERNAL		0x00000002
280 #	define TMR_MODE_MIDI	0x00000010
281 #	define TMR_MODE_FSK	0x00000020
282 #	define TMR_MODE_CLS	0x00000040
283 #	define TMR_MODE_SMPTE	0x00000080
284 #define SNDCTL_TMR_METRONOME	_IOW ('T', 7, int)
285 #define SNDCTL_TMR_SELECT	_IOW ('T', 8, int)
286 
287 /*
288  *	Endian aware patch key generation algorithm.
289  */
290 
291 #if defined(_AIX) || defined(AIX)
292 #  define _PATCHKEY(id) (0xfd00|id)
293 #else
294 #  define _PATCHKEY(id) ((id<<8)|0xfd)
295 #endif
296 
297 /*
298  *	Sample loading mechanism for internal synthesizers (/dev/sequencer)
299  *	The following patch_info structure has been designed to support
300  *	Gravis UltraSound. It tries to be universal format for uploading
301  *	sample based patches but is probably too limited.
302  */
303 
304 struct patch_info {
305 /*		u_short key;		 Use GUS_PATCH here */
306 	short key;		 /* Use GUS_PATCH here */
307 #define GUS_PATCH	_PATCHKEY(0x04)
308 #define OBSOLETE_GUS_PATCH	_PATCHKEY(0x02)
309 
310 	short device_no;	/* Synthesizer number */
311 	short instr_no;		/* Midi pgm# */
312 
313 	u_long mode;
314 /*
315  * The least significant byte has the same format than the GUS .PAT
316  * files
317  */
318 #define WAVE_16_BITS	0x01	/* bit 0 = 8 or 16 bit wave data. */
319 #define WAVE_UNSIGNED	0x02	/* bit 1 = Signed - Unsigned data. */
320 #define WAVE_LOOPING	0x04	/* bit 2 = looping enabled-1. */
321 #define WAVE_BIDIR_LOOP	0x08	/* bit 3 = Set is bidirectional looping. */
322 #define WAVE_LOOP_BACK	0x10	/* bit 4 = Set is looping backward. */
323 #define WAVE_SUSTAIN_ON	0x20	/* bit 5 = Turn sustaining on. (Env. pts. 3)*/
324 #define WAVE_ENVELOPES	0x40	/* bit 6 = Enable envelopes - 1 */
325 				/* 	(use the env_rate/env_offs fields). */
326 /* Linux specific bits */
327 #define WAVE_VIBRATO	0x00010000	/* The vibrato info is valid */
328 #define WAVE_TREMOLO	0x00020000	/* The tremolo info is valid */
329 #define WAVE_SCALE	0x00040000	/* The scaling info is valid */
330 /* Other bits must be zeroed */
331 
332 	long len;	/* Size of the wave data in bytes */
333 	long loop_start, loop_end; /* Byte offsets from the beginning */
334 
335 /*
336  * The base_freq and base_note fields are used when computing the
337  * playback speed for a note. The base_note defines the tone frequency
338  * which is heard if the sample is played using the base_freq as the
339  * playback speed.
340  *
341  * The low_note and high_note fields define the minimum and maximum note
342  * frequencies for which this sample is valid. It is possible to define
343  * more than one samples for a instrument number at the same time. The
344  * low_note and high_note fields are used to select the most suitable one.
345  *
346  * The fields base_note, high_note and low_note should contain
347  * the note frequency multiplied by 1000. For example value for the
348  * middle A is 440*1000.
349  */
350 
351 	u_int base_freq;
352 	u_long base_note;
353 	u_long high_note;
354 	u_long low_note;
355 	int panning;	/* -128=left, 127=right */
356 	int detuning;
357 
358 /*	New fields introduced in version 1.99.5	*/
359 
360        /* Envelope. Enabled by mode bit WAVE_ENVELOPES	*/
361 	u_char	env_rate[ 6 ];	 /* GUS HW ramping rate */
362 	u_char	env_offset[ 6 ]; /* 255 == 100% */
363 
364 	/*
365 	 * The tremolo, vibrato and scale info are not supported yet.
366 	 * Enable by setting the mode bits WAVE_TREMOLO, WAVE_VIBRATO or
367 	 * WAVE_SCALE
368 	 */
369 
370 	u_char	tremolo_sweep;
371 	u_char	tremolo_rate;
372 	u_char	tremolo_depth;
373 
374 	u_char	vibrato_sweep;
375 	u_char	vibrato_rate;
376 	u_char	vibrato_depth;
377 
378 	int		scale_frequency;
379 	u_int	scale_factor;		/* from 0 to 2048 or 0 to 2 */
380 
381 	int		volume;
382 	int		spare[4];
383 	char data[1];	/* The waveform data starts here */
384 };
385 
386 struct sysex_info {
387 	short key;		/* Use GUS_PATCH here */
388 #define SYSEX_PATCH	_PATCHKEY(0x05)
389 #define MAUI_PATCH	_PATCHKEY(0x06)
390 	short device_no;	/* Synthesizer number */
391 	long len;	/* Size of the sysex data in bytes */
392 	u_char data[1];	/* Sysex data starts here */
393 };
394 
395 /*
396  * Patch management interface (/dev/sequencer, /dev/patmgr#)
397  * Don't use these calls if you want to maintain compatibility with
398  * the future versions of the driver.
399  */
400 
401 #define PS_NO_PATCHES		0	/* No patch support on device */
402 #define	PS_MGR_NOT_OK		1	/* Plain patch support (no mgr) */
403 #define	PS_MGR_OK		2	/* Patch manager supported */
404 #define	PS_MANAGED		3	/* Patch manager running */
405 
406 #define SNDCTL_PMGR_IFACE		_IOWR('P', 1, struct patmgr_info)
407 
408 /*
409  * The patmgr_info is a fixed size structure which is used for two
410  * different purposes. The intended use is for communication between
411  * the application using /dev/sequencer and the patch manager daemon
412  * associated with a synthesizer device (ioctl(SNDCTL_PMGR_ACCESS)).
413  *
414  * This structure is also used with ioctl(SNDCTL_PGMR_IFACE) which allows
415  * a patch manager daemon to read and write device parameters. This
416  * ioctl available through /dev/sequencer also. Avoid using it since it's
417  * extremely hardware dependent. In addition access trough /dev/sequencer
418  * may confuse the patch manager daemon.
419  */
420 
421 struct patmgr_info {	/* Note! size must be < 4k since kmalloc() is used */
422 	  u_long key;	/* Don't worry. Reserved for communication
423 	  			   between the patch manager and the driver. */
424 #define PM_K_EVENT		1 /* Event from the /dev/sequencer driver */
425 #define PM_K_COMMAND		2 /* Request from a application */
426 #define PM_K_RESPONSE		3 /* From patmgr to application */
427 #define PM_ERROR		4 /* Error returned by the patmgr */
428 	  int device;
429 	  int command;
430 
431 /*
432  * Commands 0x000 to 0xfff reserved for patch manager programs
433  */
434 #define PM_GET_DEVTYPE	1	/* Returns type of the patch mgr interface of dev */
435 #define		PMTYPE_FM2	1	/* 2 OP fm */
436 #define		PMTYPE_FM4	2	/* Mixed 4 or 2 op FM (OPL-3) */
437 #define		PMTYPE_WAVE	3	/* Wave table synthesizer (GUS) */
438 #define PM_GET_NRPGM	2	/* Returns max # of midi programs in parm1 */
439 #define PM_GET_PGMMAP	3	/* Returns map of loaded midi programs in data8 */
440 #define PM_GET_PGM_PATCHES 4	/* Return list of patches of a program (parm1) */
441 #define PM_GET_PATCH	5	/* Return patch header of patch parm1 */
442 #define PM_SET_PATCH	6	/* Set patch header of patch parm1 */
443 #define PM_READ_PATCH	7	/* Read patch (wave) data */
444 #define PM_WRITE_PATCH	8	/* Write patch (wave) data */
445 
446 /*
447  * Commands 0x1000 to 0xffff are for communication between the patch manager
448  * and the client
449  */
450 #define _PM_LOAD_PATCH	0x100
451 
452 /*
453  * Commands above 0xffff reserved for device specific use
454  */
455 
456 	long parm1;
457 	long parm2;
458 	long parm3;
459 
460 	union {
461 		u_char data8[4000];
462 		u_short data16[2000];
463 		u_long data32[1000];
464 		struct patch_info patch;
465 	} data;
466 };
467 
468 /*
469  * When a patch manager daemon is present, it will be informed by the
470  * driver when something important happens. For example when the
471  * /dev/sequencer is opened or closed. A record with key == PM_K_EVENT is
472  * returned. The command field contains the event type:
473  */
474 #define PM_E_OPENED		1	/* /dev/sequencer opened */
475 #define PM_E_CLOSED		2	/* /dev/sequencer closed */
476 #define PM_E_PATCH_RESET	3	/* SNDCTL_RESETSAMPLES called */
477 #define PM_E_PATCH_LOADED	4	/* A patch has been loaded by appl */
478 
479 /*
480  * /dev/sequencer input events.
481  *
482  * The data written to the /dev/sequencer is a stream of events. Events
483  * are records of 4 or 8 bytes. The first byte defines the size.
484  * Any number of events can be written with a write call. There
485  * is a set of macros for sending these events. Use these macros if you
486  * want to maximize portability of your program.
487  *
488  * Events SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO. Are also input events.
489  * (All input events are currently 4 bytes long. Be prepared to support
490  * 8 byte events also. If you receive any event having first byte >= 128,
491  * it's a 8 byte event.
492  *
493  * The events are documented at the end of this file.
494  *
495  * Normal events (4 bytes)
496  * There is also a 8 byte version of most of the 4 byte events. The
497  * 8 byte one is recommended.
498  */
499 #define SEQ_NOTEOFF		0
500 #define SEQ_FMNOTEOFF		SEQ_NOTEOFF	/* Just old name */
501 #define SEQ_NOTEON		1
502 #define	SEQ_FMNOTEON		SEQ_NOTEON
503 #define SEQ_WAIT		TMR_WAIT_ABS
504 #define SEQ_PGMCHANGE		3
505 #define SEQ_FMPGMCHANGE		SEQ_PGMCHANGE
506 #define SEQ_SYNCTIMER		TMR_START
507 #define SEQ_MIDIPUTC		5
508 #define SEQ_DRUMON		6	/*** OBSOLETE ***/
509 #define SEQ_DRUMOFF		7	/*** OBSOLETE ***/
510 #define SEQ_ECHO		TMR_ECHO	/* For synching programs with output */
511 #define SEQ_AFTERTOUCH		9
512 #define SEQ_CONTROLLER		10
513 
514 /*
515  *	Midi controller numbers
516  *
517  * Controllers 0 to 31 (0x00 to 0x1f) and 32 to 63 (0x20 to 0x3f)
518  * are continuous controllers.
519  * In the MIDI 1.0 these controllers are sent using two messages.
520  * Controller numbers 0 to 31 are used to send the MSB and the
521  * controller numbers 32 to 63 are for the LSB. Note that just 7 bits
522  * are used in MIDI bytes.
523  */
524 
525 #define	CTL_BANK_SELECT		0x00
526 #define	CTL_MODWHEEL		0x01
527 #define CTL_BREATH		0x02
528 /*	undefined		0x03 */
529 #define CTL_FOOT		0x04
530 #define CTL_PORTAMENTO_TIME	0x05
531 #define CTL_DATA_ENTRY		0x06
532 #define CTL_MAIN_VOLUME		0x07
533 #define CTL_BALANCE		0x08
534 /*	undefined		0x09 */
535 #define CTL_PAN			0x0a
536 #define CTL_EXPRESSION		0x0b
537 /*	undefined		0x0c - 0x0f */
538 #define CTL_GENERAL_PURPOSE1	0x10
539 #define CTL_GENERAL_PURPOSE2	0x11
540 #define CTL_GENERAL_PURPOSE3	0x12
541 #define CTL_GENERAL_PURPOSE4	0x13
542 /*	undefined		0x14 - 0x1f */
543 
544 /*	undefined		0x20 */
545 
546 /*
547  * The controller numbers 0x21 to 0x3f are reserved for the
548  * least significant bytes of the controllers 0x00 to 0x1f.
549  * These controllers are not recognised by the driver.
550  *
551  * Controllers 64 to 69 (0x40 to 0x45) are on/off switches.
552  * 0=OFF and 127=ON (intermediate values are possible)
553  */
554 #define CTL_DAMPER_PEDAL	0x40
555 #define CTL_SUSTAIN		CTL_DAMPER_PEDAL	/* Alias */
556 #define CTL_HOLD		CTL_DAMPER_PEDAL	/* Alias */
557 #define CTL_PORTAMENTO		0x41
558 #define CTL_SOSTENUTO		0x42
559 #define CTL_SOFT_PEDAL		0x43
560 /*	undefined		0x44 */
561 #define CTL_HOLD2		0x45
562 /*	undefined		0x46 - 0x4f */
563 
564 #define CTL_GENERAL_PURPOSE5	0x50
565 #define CTL_GENERAL_PURPOSE6	0x51
566 #define CTL_GENERAL_PURPOSE7	0x52
567 #define CTL_GENERAL_PURPOSE8	0x53
568 /*	undefined		0x54 - 0x5a */
569 #define CTL_EXT_EFF_DEPTH	0x5b
570 #define CTL_TREMOLO_DEPTH	0x5c
571 #define CTL_CHORUS_DEPTH	0x5d
572 #define CTL_DETUNE_DEPTH	0x5e
573 #define CTL_CELESTE_DEPTH	CTL_DETUNE_DEPTH /* Alias for the above one */
574 #define CTL_PHASER_DEPTH	0x5f
575 #define CTL_DATA_INCREMENT	0x60
576 #define CTL_DATA_DECREMENT	0x61
577 #define CTL_NONREG_PARM_NUM_LSB	0x62
578 #define CTL_NONREG_PARM_NUM_MSB	0x63
579 #define CTL_REGIST_PARM_NUM_LSB	0x64
580 #define CTL_REGIST_PARM_NUM_MSB	0x65
581 /*	undefined		0x66 - 0x78 */
582 /*	reserved		0x79 - 0x7f */
583 
584 /* Pseudo controllers (not midi compatible) */
585 #define CTRL_PITCH_BENDER	255
586 #define CTRL_PITCH_BENDER_RANGE	254
587 #define CTRL_EXPRESSION		253	/* Obsolete */
588 #define CTRL_MAIN_VOLUME	252	/* Obsolete */
589 
590 #define SEQ_BALANCE		11
591 #define SEQ_VOLMODE             12
592 
593 /*
594  * Volume mode decides how volumes are used
595  */
596 
597 #define VOL_METHOD_ADAGIO	1
598 #define VOL_METHOD_LINEAR	2
599 
600 /*
601  * Note! SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO are used also as
602  *	 input events.
603  */
604 
605 /*
606  * Event codes 0xf0 to 0xfc are reserved for future extensions.
607  */
608 
609 #define SEQ_FULLSIZE		0xfd	/* Long events */
610 /*
611  * SEQ_FULLSIZE events are used for loading patches/samples to the
612  * synthesizer devices. These events are passed directly to the driver
613  * of the associated synthesizer device. There is no limit to the size
614  * of the extended events. These events are not queued but executed
615  * immediately when the write() is called (execution can take several
616  * seconds of time).
617  *
618  * When a SEQ_FULLSIZE message is written to the device, it must
619  * be written using exactly one write() call. Other events cannot
620  * be mixed to the same write.
621  *
622  * For FM synths (YM3812/OPL3) use struct sbi_instrument and write
623  * it to the /dev/sequencer. Don't write other data together with
624  * the instrument structure Set the key field of the structure to
625  * FM_PATCH. The device field is used to route the patch to the
626  * corresponding device.
627  *
628  * For Gravis UltraSound use struct patch_info. Initialize the key field
629  * to GUS_PATCH.
630  */
631 #define SEQ_PRIVATE	0xfe	/* Low level HW dependent events (8 bytes) */
632 #define SEQ_EXTENDED	0xff	/* Extended events (8 bytes) OBSOLETE */
633 
634 /*
635  * Record for FM patches
636  */
637 
638 typedef u_char sbi_instr_data[32];
639 
640 struct sbi_instrument {
641 	u_short	key;	/* FM_PATCH or OPL3_PATCH */
642 #define FM_PATCH	_PATCHKEY(0x01)
643 #define OPL3_PATCH	_PATCHKEY(0x03)
644 	short		device;		/* Synth# (0-4)	*/
645 	int 		channel;	/* Program# to be initialized  */
646 	sbi_instr_data	operators;	/* Reg. settings for operator cells
647 					 * (.SBI format)	*/
648 };
649 
650 struct synth_info {	/* Read only */
651 	char	name[30];
652 	int	device;		/* 0-N. INITIALIZE BEFORE CALLING */
653 	int	synth_type;
654 #define SYNTH_TYPE_FM			0
655 #define SYNTH_TYPE_SAMPLE		1
656 #define SYNTH_TYPE_MIDI			2	/* Midi interface */
657 
658 	int	synth_subtype;
659 #define FM_TYPE_ADLIB			0x00
660 #define FM_TYPE_OPL3			0x01
661 
662 #define SAMPLE_TYPE_BASIC		0x10
663 #define SAMPLE_TYPE_GUS			SAMPLE_TYPE_BASIC
664 #define SAMPLE_TYPE_AWE32		0x20
665 
666 	int	perc_mode;	/* No longer supported */
667 	int	nr_voices;
668 	int	nr_drums;	/* Obsolete field */
669 	int	instr_bank_size;
670 	u_long	capabilities;
671 #define SYNTH_CAP_PERCMODE	0x00000001 /* No longer used */
672 #define SYNTH_CAP_OPL3		0x00000002 /* Set if OPL3 supported */
673 #define SYNTH_CAP_INPUT		0x00000004 /* Input (MIDI) device */
674 	int	dummies[19];	/* Reserve space */
675 };
676 
677 struct sound_timer_info {
678 	char name[32];
679 	int caps;
680 };
681 
682 #define MIDI_CAP_MPU401		1		/* MPU-401 intelligent mode */
683 
684 struct midi_info {
685 	char		name[30];
686 	int		device;		/* 0-N. INITIALIZE BEFORE CALLING */
687 	u_long	capabilities;	/* To be defined later */
688 	int		dev_type;
689 	int		dummies[18];	/* Reserve space */
690 };
691 
692 /*
693  * ioctl commands for the /dev/midi##
694  */
695 typedef struct {
696 	u_char cmd;
697 	char nr_args, nr_returns;
698 	u_char data[30];
699 } mpu_command_rec;
700 
701 #define SNDCTL_MIDI_PRETIME	_IOWR('m', 0, int)
702 #define SNDCTL_MIDI_MPUMODE	_IOWR('m', 1, int)
703 #define SNDCTL_MIDI_MPUCMD	_IOWR('m', 2, mpu_command_rec)
704 
705 /*
706  * IOCTL commands for /dev/dsp and /dev/audio
707  */
708 
709 #define SNDCTL_DSP_RESET	_IO  ('P', 0)
710 #define SNDCTL_DSP_SYNC		_IO  ('P', 1)
711 #define SNDCTL_DSP_SPEED	_IOWR('P', 2, int)
712 #define SNDCTL_DSP_STEREO	_IOWR('P', 3, int)
713 #define SNDCTL_DSP_GETBLKSIZE	_IOR('P', 4, int)
714 #define SNDCTL_DSP_SETBLKSIZE   _IOW('P', 4, int)
715 #define SNDCTL_DSP_SETFMT	_IOWR('P',5, int) /* Selects ONE fmt*/
716 
717 /*
718  * SOUND_PCM_WRITE_CHANNELS is not that different
719  * from SNDCTL_DSP_STEREO
720  */
721 #define SOUND_PCM_WRITE_CHANNELS	_IOWR('P', 6, int)
722 #define SOUND_PCM_WRITE_FILTER	_IOWR('P', 7, int)
723 #define SNDCTL_DSP_POST		_IO  ('P', 8)
724 
725 /*
726  * SNDCTL_DSP_SETBLKSIZE and the following two calls mostly do
727  * the same thing, i.e. set the block size used in DMA transfers.
728  */
729 #define SNDCTL_DSP_SUBDIVIDE	_IOWR('P', 9, int)
730 #define SNDCTL_DSP_SETFRAGMENT	_IOWR('P',10, int)
731 
732 
733 #define SNDCTL_DSP_GETFMTS	_IOR ('P',11, int) /* Returns a mask */
734 /*
735  * Buffer status queries.
736  */
737 typedef struct audio_buf_info {
738     int fragments;	/* # of avail. frags (partly used ones not counted) */
739     int fragstotal;	/* Total # of fragments allocated */
740     int fragsize;	/* Size of a fragment in bytes */
741 
742     int bytes;	/* Avail. space in bytes (includes partly used fragments) */
743 		/* Note! 'bytes' could be more than fragments*fragsize */
744 } audio_buf_info;
745 
746 #define SNDCTL_DSP_GETOSPACE	_IOR ('P',12, audio_buf_info)
747 #define SNDCTL_DSP_GETISPACE	_IOR ('P',13, audio_buf_info)
748 
749 /*
750  * SNDCTL_DSP_NONBLOCK is the same (but less powerful, since the
751  * action cannot be undone) of FIONBIO. The same can be achieved
752  * by opening the device with O_NDELAY
753  */
754 #define SNDCTL_DSP_NONBLOCK	_IO  ('P',14)
755 
756 #define SNDCTL_DSP_GETCAPS	_IOR ('P',15, int)
757 #define DSP_CAP_REVISION	0x000000ff /* revision level (0 to 255) */
758 #define DSP_CAP_DUPLEX		0x00000100 /* Full duplex record/playback */
759 #define DSP_CAP_REALTIME	0x00000200 /* Real time capability */
760 #define DSP_CAP_BATCH		0x00000400
761     /*
762      * Device has some kind of internal buffers which may
763      * cause some delays and decrease precision of timing
764      */
765 #define DSP_CAP_COPROC		0x00000800
766     /* Has a coprocessor, sometimes it's a DSP but usually not */
767 #define DSP_CAP_TRIGGER		0x00001000 /* Supports SETTRIGGER */
768 #define DSP_CAP_MMAP 0x00002000 /* Supports mmap() */
769 
770 /*
771  * What do these function do ?
772  */
773 #define SNDCTL_DSP_GETTRIGGER	_IOR ('P',16, int)
774 #define SNDCTL_DSP_SETTRIGGER	_IOW ('P',16, int)
775 #define PCM_ENABLE_INPUT	0x00000001
776 #define PCM_ENABLE_OUTPUT	0x00000002
777 
778 typedef struct count_info {
779 	int bytes;	/* Total # of bytes processed */
780 	int blocks;	/* # of fragment transitions since last time */
781 	int ptr;	/* Current DMA pointer value */
782 } count_info;
783 
784 /*
785  * GETIPTR and GETISPACE are not that different... same for out.
786  */
787 #define SNDCTL_DSP_GETIPTR	_IOR ('P',17, count_info)
788 #define SNDCTL_DSP_GETOPTR	_IOR ('P',18, count_info)
789 
790 typedef struct buffmem_desc {
791 	caddr_t buffer;
792 	int size;
793 } buffmem_desc;
794 
795 #define SNDCTL_DSP_MAPINBUF	_IOR ('P', 19, buffmem_desc)
796 #define SNDCTL_DSP_MAPOUTBUF	_IOR ('P', 20, buffmem_desc)
797 #define SNDCTL_DSP_SETSYNCRO	_IO  ('P', 21)
798 
799 /*
800  * I guess these are the readonly version of the same
801  * functions that exist above as SNDCTL_DSP_...
802  */
803 #define SOUND_PCM_READ_RATE	_IOR ('P', 2, int)
804 #define SOUND_PCM_READ_CHANNELS	_IOR ('P', 6, int)
805 #define SOUND_PCM_READ_BITS	_IOR ('P', 5, int)
806 #define SOUND_PCM_READ_FILTER	_IOR ('P', 7, int)
807 
808 /*
809  * ioctl calls to be used in communication with coprocessors and
810  * DSP chips.
811  */
812 
813 typedef struct copr_buffer {
814 	int command;	/* Set to 0 if not used */
815 	int flags;
816 #define CPF_NONE		0x0000
817 #define CPF_FIRST		0x0001	/* First block */
818 #define CPF_LAST		0x0002	/* Last block */
819 	int len;
820 	int offs;	/* If required by the device (0 if not used) */
821 
822 	u_char data[4000]; /* NOTE! 4000 is not 4k */
823 } copr_buffer;
824 
825 typedef struct copr_debug_buf {
826 	int command;	/* Used internally. Set to 0 */
827 	int parm1;
828 	int parm2;
829 	int flags;
830 	int len;	/* Length of data in bytes */
831 } copr_debug_buf;
832 
833 typedef struct copr_msg {
834 	int len;
835 	u_char data[4000];
836 } copr_msg;
837 
838 #define SNDCTL_COPR_RESET       _IO  ('C',  0)
839 #define SNDCTL_COPR_LOAD	_IOWR('C',  1, copr_buffer)
840 #define SNDCTL_COPR_RDATA	_IOWR('C',  2, copr_debug_buf)
841 #define SNDCTL_COPR_RCODE	_IOWR('C',  3, copr_debug_buf)
842 #define SNDCTL_COPR_WDATA	_IOW ('C',  4, copr_debug_buf)
843 #define SNDCTL_COPR_WCODE	_IOW ('C',  5, copr_debug_buf)
844 #define SNDCTL_COPR_RUN		_IOWR('C',  6, copr_debug_buf)
845 #define SNDCTL_COPR_HALT	_IOWR('C',  7, copr_debug_buf)
846 #define SNDCTL_COPR_SENDMSG	_IOW ('C',  8, copr_msg)
847 #define SNDCTL_COPR_RCVMSG	_IOR ('C',  9, copr_msg)
848 
849 /*
850  * IOCTL commands for /dev/mixer
851  */
852 
853 /*
854  * Mixer devices
855  *
856  * There can be up to 20 different analog mixer channels. The
857  * SOUND_MIXER_NRDEVICES gives the currently supported maximum.
858  * The SOUND_MIXER_READ_DEVMASK returns a bitmask which tells
859  * the devices supported by the particular mixer.
860  */
861 
862 #define SOUND_MIXER_NRDEVICES	25
863 #define SOUND_MIXER_VOLUME	0
864 #define SOUND_MIXER_BASS	1
865 #define SOUND_MIXER_TREBLE	2
866 #define SOUND_MIXER_SYNTH	3
867 #define SOUND_MIXER_PCM		4
868 #define SOUND_MIXER_SPEAKER	5
869 #define SOUND_MIXER_LINE	6
870 #define SOUND_MIXER_MIC		7
871 #define SOUND_MIXER_CD		8
872 #define SOUND_MIXER_IMIX	9	/*  Recording monitor  */
873 #define SOUND_MIXER_ALTPCM	10
874 #define SOUND_MIXER_RECLEV	11	/* Recording level */
875 #define SOUND_MIXER_IGAIN	12	/* Input gain */
876 #define SOUND_MIXER_OGAIN	13	/* Output gain */
877 /*
878  * The AD1848 codec and compatibles have three line level inputs
879  * (line, aux1 and aux2). Since each card manufacturer have assigned
880  * different meanings to these inputs, it's inpractical to assign
881  * specific meanings (line, cd, synth etc.) to them.
882  */
883 #define SOUND_MIXER_LINE1	14	/* Input source 1  (aux1) */
884 #define SOUND_MIXER_LINE2	15	/* Input source 2  (aux2) */
885 #define SOUND_MIXER_LINE3	16	/* Input source 3  (line) */
886 #define SOUND_MIXER_DIGITAL1    17      /* Digital (input) 1 */
887 #define SOUND_MIXER_DIGITAL2    18      /* Digital (input) 2 */
888 #define SOUND_MIXER_DIGITAL3    19      /* Digital (input) 3 */
889 #define SOUND_MIXER_PHONEIN     20      /* Phone input */
890 #define SOUND_MIXER_PHONEOUT    21      /* Phone output */
891 #define SOUND_MIXER_VIDEO       22      /* Video/TV (audio) in */
892 #define SOUND_MIXER_RADIO       23      /* Radio in */
893 #define SOUND_MIXER_MONITOR     24      /* Monitor (usually mic) volume */
894 
895 
896 /*
897  * Some on/off settings (SOUND_SPECIAL_MIN - SOUND_SPECIAL_MAX)
898  * Not counted to SOUND_MIXER_NRDEVICES, but use the same number space
899  */
900 #define SOUND_ONOFF_MIN		28
901 #define SOUND_ONOFF_MAX		30
902 #define SOUND_MIXER_MUTE	28	/* 0 or 1 */
903 #define SOUND_MIXER_ENHANCE	29	/* Enhanced stereo (0, 40, 60 or 80) */
904 #define SOUND_MIXER_LOUD	30	/* 0 or 1 */
905 
906 /* Note!	Number 31 cannot be used since the sign bit is reserved */
907 #define SOUND_MIXER_NONE        31
908 
909 #define SOUND_DEVICE_LABELS	{ \
910 	"Vol  ", "Bass ", "Trebl", "Synth", "Pcm  ", "Spkr ", "Line ", \
911 	"Mic  ", "CD   ", "Mix  ", "Pcm2 ", "Rec  ", "IGain", "OGain", \
912 	"Line1", "Line2", "Line3", "Digital1", "Digital2", "Digital3", \
913 	"PhoneIn", "PhoneOut", "Video", "Radio", "Monitor"}
914 
915 #define SOUND_DEVICE_NAMES	{ \
916 	"vol", "bass", "treble", "synth", "pcm", "speaker", "line", \
917 	"mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", \
918 	"line1", "line2", "line3", "dig1", "dig2", "dig3", \
919 	"phin", "phout", "video", "radio", "monitor"}
920 
921 /*	Device bitmask identifiers	*/
922 
923 #define SOUND_MIXER_RECSRC	0xff	/* 1 bit per recording source */
924 #define SOUND_MIXER_DEVMASK	0xfe	/* 1 bit per supported device */
925 #define SOUND_MIXER_RECMASK	0xfd	/* 1 bit per supp. recording source */
926 #define SOUND_MIXER_CAPS	0xfc
927 #define SOUND_CAP_EXCL_INPUT	0x00000001	/* Only 1 rec. src at a time */
928 #define SOUND_MIXER_STEREODEVS	0xfb	/* Mixer channels supporting stereo */
929 
930 /*	Device mask bits	*/
931 
932 #define SOUND_MASK_VOLUME	(1 << SOUND_MIXER_VOLUME)
933 #define SOUND_MASK_BASS		(1 << SOUND_MIXER_BASS)
934 #define SOUND_MASK_TREBLE	(1 << SOUND_MIXER_TREBLE)
935 #define SOUND_MASK_SYNTH	(1 << SOUND_MIXER_SYNTH)
936 #define SOUND_MASK_PCM		(1 << SOUND_MIXER_PCM)
937 #define SOUND_MASK_SPEAKER	(1 << SOUND_MIXER_SPEAKER)
938 #define SOUND_MASK_LINE		(1 << SOUND_MIXER_LINE)
939 #define SOUND_MASK_MIC		(1 << SOUND_MIXER_MIC)
940 #define SOUND_MASK_CD		(1 << SOUND_MIXER_CD)
941 #define SOUND_MASK_IMIX		(1 << SOUND_MIXER_IMIX)
942 #define SOUND_MASK_ALTPCM	(1 << SOUND_MIXER_ALTPCM)
943 #define SOUND_MASK_RECLEV	(1 << SOUND_MIXER_RECLEV)
944 #define SOUND_MASK_IGAIN	(1 << SOUND_MIXER_IGAIN)
945 #define SOUND_MASK_OGAIN	(1 << SOUND_MIXER_OGAIN)
946 #define SOUND_MASK_LINE1	(1 << SOUND_MIXER_LINE1)
947 #define SOUND_MASK_LINE2	(1 << SOUND_MIXER_LINE2)
948 #define SOUND_MASK_LINE3	(1 << SOUND_MIXER_LINE3)
949 #define SOUND_MASK_DIGITAL1     (1 << SOUND_MIXER_DIGITAL1)
950 #define SOUND_MASK_DIGITAL2     (1 << SOUND_MIXER_DIGITAL2)
951 #define SOUND_MASK_DIGITAL3     (1 << SOUND_MIXER_DIGITAL3)
952 #define SOUND_MASK_PHONEIN      (1 << SOUND_MIXER_PHONEIN)
953 #define SOUND_MASK_PHONEOUT     (1 << SOUND_MIXER_PHONEOUT)
954 #define SOUND_MASK_RADIO        (1 << SOUND_MIXER_RADIO)
955 #define SOUND_MASK_VIDEO        (1 << SOUND_MIXER_VIDEO)
956 #define SOUND_MASK_MONITOR      (1 << SOUND_MIXER_MONITOR)
957 
958 /* Obsolete macros */
959 #define SOUND_MASK_MUTE		(1 << SOUND_MIXER_MUTE)
960 #define SOUND_MASK_ENHANCE	(1 << SOUND_MIXER_ENHANCE)
961 #define SOUND_MASK_LOUD		(1 << SOUND_MIXER_LOUD)
962 
963 #define MIXER_READ(dev)		_IOR('M', dev, int)
964 #define SOUND_MIXER_READ_VOLUME		MIXER_READ(SOUND_MIXER_VOLUME)
965 #define SOUND_MIXER_READ_BASS		MIXER_READ(SOUND_MIXER_BASS)
966 #define SOUND_MIXER_READ_TREBLE		MIXER_READ(SOUND_MIXER_TREBLE)
967 #define SOUND_MIXER_READ_SYNTH		MIXER_READ(SOUND_MIXER_SYNTH)
968 #define SOUND_MIXER_READ_PCM		MIXER_READ(SOUND_MIXER_PCM)
969 #define SOUND_MIXER_READ_SPEAKER	MIXER_READ(SOUND_MIXER_SPEAKER)
970 #define SOUND_MIXER_READ_LINE		MIXER_READ(SOUND_MIXER_LINE)
971 #define SOUND_MIXER_READ_MIC		MIXER_READ(SOUND_MIXER_MIC)
972 #define SOUND_MIXER_READ_CD		MIXER_READ(SOUND_MIXER_CD)
973 #define SOUND_MIXER_READ_IMIX		MIXER_READ(SOUND_MIXER_IMIX)
974 #define SOUND_MIXER_READ_ALTPCM		MIXER_READ(SOUND_MIXER_ALTPCM)
975 #define SOUND_MIXER_READ_RECLEV		MIXER_READ(SOUND_MIXER_RECLEV)
976 #define SOUND_MIXER_READ_IGAIN		MIXER_READ(SOUND_MIXER_IGAIN)
977 #define SOUND_MIXER_READ_OGAIN		MIXER_READ(SOUND_MIXER_OGAIN)
978 #define SOUND_MIXER_READ_LINE1		MIXER_READ(SOUND_MIXER_LINE1)
979 #define SOUND_MIXER_READ_LINE2		MIXER_READ(SOUND_MIXER_LINE2)
980 #define SOUND_MIXER_READ_LINE3		MIXER_READ(SOUND_MIXER_LINE3)
981 
982 /* Obsolete macros */
983 #define SOUND_MIXER_READ_MUTE		MIXER_READ(SOUND_MIXER_MUTE)
984 #define SOUND_MIXER_READ_ENHANCE	MIXER_READ(SOUND_MIXER_ENHANCE)
985 #define SOUND_MIXER_READ_LOUD		MIXER_READ(SOUND_MIXER_LOUD)
986 
987 #define SOUND_MIXER_READ_RECSRC		MIXER_READ(SOUND_MIXER_RECSRC)
988 #define SOUND_MIXER_READ_DEVMASK	MIXER_READ(SOUND_MIXER_DEVMASK)
989 #define SOUND_MIXER_READ_RECMASK	MIXER_READ(SOUND_MIXER_RECMASK)
990 #define SOUND_MIXER_READ_STEREODEVS	MIXER_READ(SOUND_MIXER_STEREODEVS)
991 #define SOUND_MIXER_READ_CAPS		MIXER_READ(SOUND_MIXER_CAPS)
992 
993 #define MIXER_WRITE(dev)		_IOWR('M', dev, int)
994 #define SOUND_MIXER_WRITE_VOLUME	MIXER_WRITE(SOUND_MIXER_VOLUME)
995 #define SOUND_MIXER_WRITE_BASS		MIXER_WRITE(SOUND_MIXER_BASS)
996 #define SOUND_MIXER_WRITE_TREBLE	MIXER_WRITE(SOUND_MIXER_TREBLE)
997 #define SOUND_MIXER_WRITE_SYNTH		MIXER_WRITE(SOUND_MIXER_SYNTH)
998 #define SOUND_MIXER_WRITE_PCM		MIXER_WRITE(SOUND_MIXER_PCM)
999 #define SOUND_MIXER_WRITE_SPEAKER	MIXER_WRITE(SOUND_MIXER_SPEAKER)
1000 #define SOUND_MIXER_WRITE_LINE		MIXER_WRITE(SOUND_MIXER_LINE)
1001 #define SOUND_MIXER_WRITE_MIC		MIXER_WRITE(SOUND_MIXER_MIC)
1002 #define SOUND_MIXER_WRITE_CD		MIXER_WRITE(SOUND_MIXER_CD)
1003 #define SOUND_MIXER_WRITE_IMIX		MIXER_WRITE(SOUND_MIXER_IMIX)
1004 #define SOUND_MIXER_WRITE_ALTPCM	MIXER_WRITE(SOUND_MIXER_ALTPCM)
1005 #define SOUND_MIXER_WRITE_RECLEV	MIXER_WRITE(SOUND_MIXER_RECLEV)
1006 #define SOUND_MIXER_WRITE_IGAIN		MIXER_WRITE(SOUND_MIXER_IGAIN)
1007 #define SOUND_MIXER_WRITE_OGAIN		MIXER_WRITE(SOUND_MIXER_OGAIN)
1008 #define SOUND_MIXER_WRITE_LINE1		MIXER_WRITE(SOUND_MIXER_LINE1)
1009 #define SOUND_MIXER_WRITE_LINE2		MIXER_WRITE(SOUND_MIXER_LINE2)
1010 #define SOUND_MIXER_WRITE_LINE3		MIXER_WRITE(SOUND_MIXER_LINE3)
1011 #define SOUND_MIXER_WRITE_MUTE		MIXER_WRITE(SOUND_MIXER_MUTE)
1012 #define SOUND_MIXER_WRITE_ENHANCE	MIXER_WRITE(SOUND_MIXER_ENHANCE)
1013 #define SOUND_MIXER_WRITE_LOUD		MIXER_WRITE(SOUND_MIXER_LOUD)
1014 
1015 #define SOUND_MIXER_WRITE_RECSRC	MIXER_WRITE(SOUND_MIXER_RECSRC)
1016 
1017 #define LEFT_CHN	0
1018 #define RIGHT_CHN	1
1019 
1020 /*
1021  * Level 2 event types for /dev/sequencer
1022  */
1023 
1024 /*
1025  * The 4 most significant bits of byte 0 specify the class of
1026  * the event:
1027  *
1028  *	0x8X = system level events,
1029  *	0x9X = device/port specific events, event[1] = device/port,
1030  *		The last 4 bits give the subtype:
1031  *			0x02	= Channel event (event[3] = chn).
1032  *			0x01	= note event (event[4] = note).
1033  *			(0x01 is not used alone but always with bit 0x02).
1034  *	       event[2] = MIDI message code (0x80=note off etc.)
1035  *
1036  */
1037 
1038 #define EV_SEQ_LOCAL		0x80
1039 #define EV_TIMING		0x81
1040 #define EV_CHN_COMMON		0x92
1041 #define EV_CHN_VOICE		0x93
1042 #define EV_SYSEX		0x94
1043 /*
1044  * Event types 200 to 220 are reserved for application use.
1045  * These numbers will not be used by the driver.
1046  */
1047 
1048 /*
1049  * Events for event type EV_CHN_VOICE
1050  */
1051 
1052 #define MIDI_NOTEOFF		0x80
1053 #define MIDI_NOTEON		0x90
1054 #define MIDI_KEY_PRESSURE	0xA0
1055 
1056 /*
1057  * Events for event type EV_CHN_COMMON
1058  */
1059 
1060 #define MIDI_CTL_CHANGE		0xB0
1061 #define MIDI_PGM_CHANGE		0xC0
1062 #define MIDI_CHN_PRESSURE	0xD0
1063 #define MIDI_PITCH_BEND		0xE0
1064 
1065 #define MIDI_SYSTEM_PREFIX	0xF0
1066 
1067 /*
1068  * Timer event types
1069  */
1070 #define TMR_WAIT_REL		1	/* Time relative to the prev time */
1071 #define TMR_WAIT_ABS		2	/* Absolute time since TMR_START */
1072 #define TMR_STOP		3
1073 #define TMR_START		4
1074 #define TMR_CONTINUE		5
1075 #define TMR_TEMPO		6
1076 #define TMR_ECHO		8
1077 #define TMR_CLOCK		9	/* MIDI clock */
1078 #define TMR_SPP			10	/* Song position pointer */
1079 #define TMR_TIMESIG		11	/* Time signature */
1080 
1081 /*
1082  *	Local event types
1083  */
1084 #define LOCL_STARTAUDIO		1
1085 
1086 #if (!defined(__KERNEL__) && !defined(KERNEL) && !defined(INKERNEL) && !defined(_KERNEL)) || defined(USE_SEQ_MACROS)
1087 /*
1088  *	Some convenience macros to simplify programming of the
1089  *	/dev/sequencer interface
1090  *
1091  *	These macros define the API which should be used when possible.
1092  */
1093 
1094 #ifndef USE_SIMPLE_MACROS
1095 void seqbuf_dump(void);	/* This function must be provided by programs */
1096 
1097 /* Sample seqbuf_dump() implementation:
1098  *
1099  *	SEQ_DEFINEBUF (2048);	-- Defines a buffer for 2048 bytes
1100  *
1101  *	int seqfd;		-- The file descriptor for /dev/sequencer.
1102  *
1103  *	void
1104  *	seqbuf_dump ()
1105  *	{
1106  *	  if (_seqbufptr)
1107  *	    if (write (seqfd, _seqbuf, _seqbufptr) == -1)
1108  *	      {
1109  *		perror ("write /dev/sequencer");
1110  *		exit (-1);
1111  *	      }
1112  *	  _seqbufptr = 0;
1113  *	}
1114  */
1115 
1116 #define SEQ_DEFINEBUF(len)		\
1117 	u_char _seqbuf[len]; int _seqbuflen = len;int _seqbufptr = 0
1118 #define SEQ_USE_EXTBUF()		\
1119 	extern u_char _seqbuf[]; \
1120 	extern int _seqbuflen;extern int _seqbufptr
1121 #define SEQ_DECLAREBUF()		SEQ_USE_EXTBUF()
1122 #define SEQ_PM_DEFINES			struct patmgr_info _pm_info
1123 #define _SEQ_NEEDBUF(len)		\
1124 	if ((_seqbufptr+(len)) > _seqbuflen) \
1125 		seqbuf_dump()
1126 #define _SEQ_ADVBUF(len)		_seqbufptr += len
1127 #define SEQ_DUMPBUF			seqbuf_dump
1128 #else
1129 /*
1130  * This variation of the sequencer macros is used just to format one event
1131  * using fixed buffer.
1132  *
1133  * The program using the macro library must define the following macros before
1134  * using this library.
1135  *
1136  * #define _seqbuf 		 name of the buffer (u_char[])
1137  * #define _SEQ_ADVBUF(len)	 If the applic needs to know the exact
1138  *				 size of the event, this macro can be used.
1139  *				 Otherwise this must be defined as empty.
1140  * #define _seqbufptr		 Define the name of index variable or 0 if
1141  *				 not required.
1142  */
1143 #define _SEQ_NEEDBUF(len)	/* empty */
1144 #endif
1145 
1146 #define PM_LOAD_PATCH(dev, bank, pgm)	\
1147 	(SEQ_DUMPBUF(), _pm_info.command = _PM_LOAD_PATCH, \
1148 	_pm_info.device=dev, _pm_info.data.data8[0]=pgm, \
1149 	_pm_info.parm1 = bank, _pm_info.parm2 = 1, \
1150 	ioctl(seqfd, SNDCTL_PMGR_ACCESS, &_pm_info))
1151 #define PM_LOAD_PATCHES(dev, bank, pgm) \
1152 	(SEQ_DUMPBUF(), _pm_info.command = _PM_LOAD_PATCH, \
1153 	_pm_info.device=dev, bcopy( pgm, _pm_info.data.data8,  128), \
1154 	_pm_info.parm1 = bank, _pm_info.parm2 = 128, \
1155 	ioctl(seqfd, SNDCTL_PMGR_ACCESS, &_pm_info))
1156 
1157 #define SEQ_VOLUME_MODE(dev, mode)	{ \
1158 	_SEQ_NEEDBUF(8);\
1159 	_seqbuf[_seqbufptr] = SEQ_EXTENDED;\
1160 	_seqbuf[_seqbufptr+1] = SEQ_VOLMODE;\
1161 	_seqbuf[_seqbufptr+2] = (dev);\
1162 	_seqbuf[_seqbufptr+3] = (mode);\
1163 	_seqbuf[_seqbufptr+4] = 0;\
1164 	_seqbuf[_seqbufptr+5] = 0;\
1165 	_seqbuf[_seqbufptr+6] = 0;\
1166 	_seqbuf[_seqbufptr+7] = 0;\
1167 	_SEQ_ADVBUF(8);}
1168 
1169 /*
1170  * Midi voice messages
1171  */
1172 
1173 #define _CHN_VOICE(dev, event, chn, note, parm)  { \
1174 	_SEQ_NEEDBUF(8);\
1175 	_seqbuf[_seqbufptr] = EV_CHN_VOICE;\
1176 	_seqbuf[_seqbufptr+1] = (dev);\
1177 	_seqbuf[_seqbufptr+2] = (event);\
1178 	_seqbuf[_seqbufptr+3] = (chn);\
1179 	_seqbuf[_seqbufptr+4] = (note);\
1180 	_seqbuf[_seqbufptr+5] = (parm);\
1181 	_seqbuf[_seqbufptr+6] = (0);\
1182 	_seqbuf[_seqbufptr+7] = 0;\
1183 	_SEQ_ADVBUF(8);}
1184 
1185 #define SEQ_START_NOTE(dev, chn, note, vol) \
1186 		_CHN_VOICE(dev, MIDI_NOTEON, chn, note, vol)
1187 
1188 #define SEQ_STOP_NOTE(dev, chn, note, vol) \
1189 		_CHN_VOICE(dev, MIDI_NOTEOFF, chn, note, vol)
1190 
1191 #define SEQ_KEY_PRESSURE(dev, chn, note, pressure) \
1192 		_CHN_VOICE(dev, MIDI_KEY_PRESSURE, chn, note, pressure)
1193 
1194 /*
1195  * Midi channel messages
1196  */
1197 
1198 #define _CHN_COMMON(dev, event, chn, p1, p2, w14) { \
1199 	_SEQ_NEEDBUF(8);\
1200 	_seqbuf[_seqbufptr] = EV_CHN_COMMON;\
1201 	_seqbuf[_seqbufptr+1] = (dev);\
1202 	_seqbuf[_seqbufptr+2] = (event);\
1203 	_seqbuf[_seqbufptr+3] = (chn);\
1204 	_seqbuf[_seqbufptr+4] = (p1);\
1205 	_seqbuf[_seqbufptr+5] = (p2);\
1206 	*(short *)&_seqbuf[_seqbufptr+6] = (w14);\
1207 	_SEQ_ADVBUF(8);}
1208 /*
1209  * SEQ_SYSEX permits sending of sysex messages. (It may look that it permits
1210  * sending any MIDI bytes but it's absolutely not possible. Trying to do
1211  * so _will_ cause problems with MPU401 intelligent mode).
1212  *
1213  * Sysex messages are sent in blocks of 1 to 6 bytes. Longer messages must be
1214  * sent by calling SEQ_SYSEX() several times (there must be no other events
1215  * between them). First sysex fragment must have 0xf0 in the first byte
1216  * and the last byte (buf[len-1] of the last fragment must be 0xf7. No byte
1217  * between these sysex start and end markers cannot be larger than 0x7f. Also
1218  * lengths of each fragments (except the last one) must be 6.
1219  *
1220  * Breaking the above rules may work with some MIDI ports but is likely to
1221  * cause fatal problems with some other devices (such as MPU401).
1222  */
1223 #define SEQ_SYSEX(dev, buf, len) { \
1224 	int i, l=(len); if (l>6)l=6;\
1225 	_SEQ_NEEDBUF(8);\
1226 	_seqbuf[_seqbufptr] = EV_SYSEX;\
1227 	for(i=0;i<l;i++)_seqbuf[_seqbufptr+i+1] = (buf)[i];\
1228 	for(i=l;i<6;i++)_seqbuf[_seqbufptr+i+1] = 0xff;\
1229 	_SEQ_ADVBUF(8);}
1230 
1231 #define SEQ_CHN_PRESSURE(dev, chn, pressure) \
1232 	_CHN_COMMON(dev, MIDI_CHN_PRESSURE, chn, pressure, 0, 0)
1233 
1234 #define SEQ_SET_PATCH(dev, chn, patch) \
1235 	_CHN_COMMON(dev, MIDI_PGM_CHANGE, chn, patch, 0, 0)
1236 
1237 #define SEQ_CONTROL(dev, chn, controller, value) \
1238 	_CHN_COMMON(dev, MIDI_CTL_CHANGE, chn, controller, 0, value)
1239 
1240 #define SEQ_BENDER(dev, chn, value) \
1241 	_CHN_COMMON(dev, MIDI_PITCH_BEND, chn, 0, 0, value)
1242 
1243 
1244 #define SEQ_V2_X_CONTROL(dev, voice, controller, value)	{ \
1245 	_SEQ_NEEDBUF(8);\
1246 	_seqbuf[_seqbufptr] = SEQ_EXTENDED;\
1247 	_seqbuf[_seqbufptr+1] = SEQ_CONTROLLER;\
1248 	_seqbuf[_seqbufptr+2] = (dev);\
1249 	_seqbuf[_seqbufptr+3] = (voice);\
1250 	_seqbuf[_seqbufptr+4] = (controller);\
1251 	*(short *)&_seqbuf[_seqbufptr+5] = (value);\
1252 	_seqbuf[_seqbufptr+7] = 0;\
1253 	_SEQ_ADVBUF(8);}
1254 
1255 /*
1256  * The following 5 macros are incorrectly implemented and obsolete.
1257  * Use SEQ_BENDER and SEQ_CONTROL (with proper controller) instead.
1258  */
1259 
1260 #define SEQ_PITCHBEND(dev, voice, value) \
1261 	SEQ_V2_X_CONTROL(dev, voice, CTRL_PITCH_BENDER, value)
1262 #define SEQ_BENDER_RANGE(dev, voice, value) \
1263 	SEQ_V2_X_CONTROL(dev, voice, CTRL_PITCH_BENDER_RANGE, value)
1264 #define SEQ_EXPRESSION(dev, voice, value) \
1265 	SEQ_CONTROL(dev, voice, CTL_EXPRESSION, value*128)
1266 #define SEQ_MAIN_VOLUME(dev, voice, value) \
1267 	SEQ_CONTROL(dev, voice, CTL_MAIN_VOLUME, (value*16383)/100)
1268 #define SEQ_PANNING(dev, voice, pos) \
1269 	SEQ_CONTROL(dev, voice, CTL_PAN, (pos+128) / 2)
1270 
1271 /*
1272  * Timing and syncronization macros
1273  */
1274 
1275 #define _TIMER_EVENT(ev, parm)		{ \
1276 	_SEQ_NEEDBUF(8);\
1277 	_seqbuf[_seqbufptr+0] = EV_TIMING; \
1278 	_seqbuf[_seqbufptr+1] = (ev); \
1279 	_seqbuf[_seqbufptr+2] = 0;\
1280 	_seqbuf[_seqbufptr+3] = 0;\
1281 	*(u_int *)&_seqbuf[_seqbufptr+4] = (parm); \
1282 	_SEQ_ADVBUF(8); \
1283 	}
1284 
1285 #define SEQ_START_TIMER()		_TIMER_EVENT(TMR_START, 0)
1286 #define SEQ_STOP_TIMER()		_TIMER_EVENT(TMR_STOP, 0)
1287 #define SEQ_CONTINUE_TIMER()		_TIMER_EVENT(TMR_CONTINUE, 0)
1288 #define SEQ_WAIT_TIME(ticks)		_TIMER_EVENT(TMR_WAIT_ABS, ticks)
1289 #define SEQ_DELTA_TIME(ticks)		_TIMER_EVENT(TMR_WAIT_REL, ticks)
1290 #define SEQ_ECHO_BACK(key)		_TIMER_EVENT(TMR_ECHO, key)
1291 #define SEQ_SET_TEMPO(value)		_TIMER_EVENT(TMR_TEMPO, value)
1292 #define SEQ_SONGPOS(pos)		_TIMER_EVENT(TMR_SPP, pos)
1293 #define SEQ_TIME_SIGNATURE(sig)		_TIMER_EVENT(TMR_TIMESIG, sig)
1294 
1295 /*
1296  * Local control events
1297  */
1298 
1299 #define _LOCAL_EVENT(ev, parm)		{ \
1300 	_SEQ_NEEDBUF(8);\
1301 	_seqbuf[_seqbufptr+0] = EV_SEQ_LOCAL; \
1302 	_seqbuf[_seqbufptr+1] = (ev); \
1303 	_seqbuf[_seqbufptr+2] = 0;\
1304 	_seqbuf[_seqbufptr+3] = 0;\
1305 	*(u_int *)&_seqbuf[_seqbufptr+4] = (parm); \
1306 	_SEQ_ADVBUF(8); \
1307 	}
1308 
1309 #define SEQ_PLAYAUDIO(devmask)		_LOCAL_EVENT(LOCL_STARTAUDIO, devmask)
1310 /*
1311  * Events for the level 1 interface only
1312  */
1313 
1314 #define SEQ_MIDIOUT(device, byte)	{ \
1315 	_SEQ_NEEDBUF(4);\
1316 	_seqbuf[_seqbufptr] = SEQ_MIDIPUTC;\
1317 	_seqbuf[_seqbufptr+1] = (byte);\
1318 	_seqbuf[_seqbufptr+2] = (device);\
1319 	_seqbuf[_seqbufptr+3] = 0;\
1320 	_SEQ_ADVBUF(4);}
1321 
1322 /*
1323  * Patch loading.
1324  */
1325 #define SEQ_WRPATCH(patchx, len)	{ \
1326 	if (_seqbufptr) seqbuf_dump(); \
1327 	if (write(seqfd, (char*)(patchx), len)==-1) \
1328 	   perror("Write patch: /dev/sequencer"); \
1329 	}
1330 
1331 #define SEQ_WRPATCH2(patchx, len)	\
1332 	( seqbuf_dump(), write(seqfd, (char*)(patchx), len) )
1333 
1334 #endif
1335 
1336 /*
1337  * Here I have moved all the aliases for ioctl names.
1338  */
1339 
1340 #define SNDCTL_DSP_SAMPLESIZE	SNDCTL_DSP_SETFMT
1341 #define SOUND_PCM_WRITE_BITS	SNDCTL_DSP_SETFMT
1342 #define SOUND_PCM_SETFMT	SNDCTL_DSP_SETFMT
1343 
1344 #define SOUND_PCM_WRITE_RATE	SNDCTL_DSP_SPEED
1345 #define SOUND_PCM_POST		SNDCTL_DSP_POST
1346 #define SOUND_PCM_RESET		SNDCTL_DSP_RESET
1347 #define SOUND_PCM_SYNC		SNDCTL_DSP_SYNC
1348 #define SOUND_PCM_SUBDIVIDE	SNDCTL_DSP_SUBDIVIDE
1349 #define SOUND_PCM_SETFRAGMENT	SNDCTL_DSP_SETFRAGMENT
1350 #define SOUND_PCM_GETFMTS	SNDCTL_DSP_GETFMTS
1351 #define SOUND_PCM_GETOSPACE	SNDCTL_DSP_GETOSPACE
1352 #define SOUND_PCM_GETISPACE	SNDCTL_DSP_GETISPACE
1353 #define SOUND_PCM_NONBLOCK	SNDCTL_DSP_NONBLOCK
1354 #define SOUND_PCM_GETCAPS	SNDCTL_DSP_GETCAPS
1355 #define SOUND_PCM_GETTRIGGER	SNDCTL_DSP_GETTRIGGER
1356 #define SOUND_PCM_SETTRIGGER	SNDCTL_DSP_SETTRIGGER
1357 #define SOUND_PCM_SETSYNCRO	SNDCTL_DSP_SETSYNCRO
1358 #define SOUND_PCM_GETIPTR	SNDCTL_DSP_GETIPTR
1359 #define SOUND_PCM_GETOPTR	SNDCTL_DSP_GETOPTR
1360 #define SOUND_PCM_MAPINBUF	SNDCTL_DSP_MAPINBUF
1361 #define SOUND_PCM_MAPOUTBUF	SNDCTL_DSP_MAPOUTBUF
1362 
1363 #endif	/* SOUNDCARD_H */
1364