blob: dfcf86f013a9492624ba14874be39380199ed236 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef SOUNDCARD_H
2#define SOUNDCARD_H
3/*
4 * Copyright by Hannu Savolainen 1993-1997
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer. 2.
10 * Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
18 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27
28/*
29 * OSS interface version. With versions earlier than 3.6 this value is
30 * an integer with value less than 361. In versions 3.6 and later
31 * it's a six digit hexadecimal value. For example value
32 * of 0x030600 represents OSS version 3.6.0.
33 * Use ioctl(fd, OSS_GETVERSION, &int) to get the version number of
34 * the currently active driver.
35 */
36#define SOUND_VERSION 0x030802
37#define OPEN_SOUND_SYSTEM
38
39/* In Linux we need to be prepared for cross compiling */
40#include <linux/ioctl.h>
41
Stuart Brady60d300c2005-05-05 16:15:07 -070042/* Endian macros. */
43#ifdef __KERNEL__
44# include <asm/byteorder.h>
45#else
46# include <endian.h>
47#endif
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/*
50 * Supported card ID numbers (Should be somewhere else?)
51 */
52
53#define SNDCARD_ADLIB 1
54#define SNDCARD_SB 2
55#define SNDCARD_PAS 3
56#define SNDCARD_GUS 4
57#define SNDCARD_MPU401 5
58#define SNDCARD_SB16 6
59#define SNDCARD_SB16MIDI 7
60#define SNDCARD_UART6850 8
61#define SNDCARD_GUS16 9
62#define SNDCARD_MSS 10
63#define SNDCARD_PSS 11
64#define SNDCARD_SSCAPE 12
65#define SNDCARD_PSS_MPU 13
66#define SNDCARD_PSS_MSS 14
67#define SNDCARD_SSCAPE_MSS 15
68#define SNDCARD_TRXPRO 16
69#define SNDCARD_TRXPRO_SB 17
70#define SNDCARD_TRXPRO_MPU 18
71#define SNDCARD_MAD16 19
72#define SNDCARD_MAD16_MPU 20
73#define SNDCARD_CS4232 21
74#define SNDCARD_CS4232_MPU 22
75#define SNDCARD_MAUI 23
76#define SNDCARD_PSEUDO_MSS 24
77#define SNDCARD_GUSPNP 25
78#define SNDCARD_UART401 26
79/* Sound card numbers 27 to N are reserved. Don't add more numbers here. */
80
81/***********************************
82 * IOCTL Commands for /dev/sequencer
83 */
84
85#ifndef _SIOWR
86#if defined(_IOWR) && (defined(_AIX) || (!defined(sun) && !defined(sparc) && !defined(__sparc__) && !defined(__INCioctlh) && !defined(__Lynx__)))
87/* Use already defined ioctl defines if they exist (except with Sun or Sparc) */
88#define SIOCPARM_MASK IOCPARM_MASK
89#define SIOC_VOID IOC_VOID
90#define SIOC_OUT IOC_OUT
91#define SIOC_IN IOC_IN
92#define SIOC_INOUT IOC_INOUT
93#define _SIOC_SIZE _IOC_SIZE
94#define _SIOC_DIR _IOC_DIR
95#define _SIOC_NONE _IOC_NONE
96#define _SIOC_READ _IOC_READ
97#define _SIOC_WRITE _IOC_WRITE
98#define _SIO _IO
99#define _SIOR _IOR
100#define _SIOW _IOW
101#define _SIOWR _IOWR
102#else
103
104/* Ioctl's have the command encoded in the lower word,
105 * and the size of any in or out parameters in the upper
106 * word. The high 2 bits of the upper word are used
107 * to encode the in/out status of the parameter; for now
108 * we restrict parameters to at most 8191 bytes.
109 */
110/* #define SIOCTYPE (0xff<<8) */
111#define SIOCPARM_MASK 0x1fff /* parameters must be < 8192 bytes */
112#define SIOC_VOID 0x00000000 /* no parameters */
113#define SIOC_OUT 0x20000000 /* copy out parameters */
114#define SIOC_IN 0x40000000 /* copy in parameters */
115#define SIOC_INOUT (SIOC_IN|SIOC_OUT)
116/* the 0x20000000 is so we can distinguish new ioctl's from old */
117#define _SIO(x,y) ((int)(SIOC_VOID|(x<<8)|y))
118#define _SIOR(x,y,t) ((int)(SIOC_OUT|((sizeof(t)&SIOCPARM_MASK)<<16)|(x<<8)|y))
119#define _SIOW(x,y,t) ((int)(SIOC_IN|((sizeof(t)&SIOCPARM_MASK)<<16)|(x<<8)|y))
120/* this should be _SIORW, but stdio got there first */
121#define _SIOWR(x,y,t) ((int)(SIOC_INOUT|((sizeof(t)&SIOCPARM_MASK)<<16)|(x<<8)|y))
122#define _SIOC_SIZE(x) ((x>>16)&SIOCPARM_MASK)
123#define _SIOC_DIR(x) (x & 0xf0000000)
124#define _SIOC_NONE SIOC_VOID
125#define _SIOC_READ SIOC_OUT
126#define _SIOC_WRITE SIOC_IN
127# endif /* _IOWR */
128#endif /* !_SIOWR */
129
130#define SNDCTL_SEQ_RESET _SIO ('Q', 0)
131#define SNDCTL_SEQ_SYNC _SIO ('Q', 1)
132#define SNDCTL_SYNTH_INFO _SIOWR('Q', 2, struct synth_info)
133#define SNDCTL_SEQ_CTRLRATE _SIOWR('Q', 3, int) /* Set/get timer resolution (HZ) */
134#define SNDCTL_SEQ_GETOUTCOUNT _SIOR ('Q', 4, int)
135#define SNDCTL_SEQ_GETINCOUNT _SIOR ('Q', 5, int)
136#define SNDCTL_SEQ_PERCMODE _SIOW ('Q', 6, int)
137#define SNDCTL_FM_LOAD_INSTR _SIOW ('Q', 7, struct sbi_instrument) /* Obsolete. Don't use!!!!!! */
138#define SNDCTL_SEQ_TESTMIDI _SIOW ('Q', 8, int)
139#define SNDCTL_SEQ_RESETSAMPLES _SIOW ('Q', 9, int)
140#define SNDCTL_SEQ_NRSYNTHS _SIOR ('Q',10, int)
141#define SNDCTL_SEQ_NRMIDIS _SIOR ('Q',11, int)
142#define SNDCTL_MIDI_INFO _SIOWR('Q',12, struct midi_info)
143#define SNDCTL_SEQ_THRESHOLD _SIOW ('Q',13, int)
144#define SNDCTL_SYNTH_MEMAVL _SIOWR('Q',14, int) /* in=dev#, out=memsize */
145#define SNDCTL_FM_4OP_ENABLE _SIOW ('Q',15, int) /* in=dev# */
146#define SNDCTL_SEQ_PANIC _SIO ('Q',17)
147#define SNDCTL_SEQ_OUTOFBAND _SIOW ('Q',18, struct seq_event_rec)
148#define SNDCTL_SEQ_GETTIME _SIOR ('Q',19, int)
149#define SNDCTL_SYNTH_ID _SIOWR('Q',20, struct synth_info)
150#define SNDCTL_SYNTH_CONTROL _SIOWR('Q',21, struct synth_control)
151#define SNDCTL_SYNTH_REMOVESAMPLE _SIOWR('Q',22, struct remove_sample)
152
153typedef struct synth_control
154{
155 int devno; /* Synthesizer # */
156 char data[4000]; /* Device spesific command/data record */
157}synth_control;
158
159typedef struct remove_sample
160{
161 int devno; /* Synthesizer # */
162 int bankno; /* MIDI bank # (0=General MIDI) */
163 int instrno; /* MIDI instrument number */
164} remove_sample;
165
166typedef struct seq_event_rec {
167 unsigned char arr[8];
168} seq_event_rec;
169
170#define SNDCTL_TMR_TIMEBASE _SIOWR('T', 1, int)
171#define SNDCTL_TMR_START _SIO ('T', 2)
172#define SNDCTL_TMR_STOP _SIO ('T', 3)
173#define SNDCTL_TMR_CONTINUE _SIO ('T', 4)
174#define SNDCTL_TMR_TEMPO _SIOWR('T', 5, int)
175#define SNDCTL_TMR_SOURCE _SIOWR('T', 6, int)
176# define TMR_INTERNAL 0x00000001
177# define TMR_EXTERNAL 0x00000002
178# define TMR_MODE_MIDI 0x00000010
179# define TMR_MODE_FSK 0x00000020
180# define TMR_MODE_CLS 0x00000040
181# define TMR_MODE_SMPTE 0x00000080
182#define SNDCTL_TMR_METRONOME _SIOW ('T', 7, int)
183#define SNDCTL_TMR_SELECT _SIOW ('T', 8, int)
184
185/*
186 * Some big endian/little endian handling macros
187 */
188
Stuart Brady60d300c2005-05-05 16:15:07 -0700189#define _LINUX_PATCHKEY_H_INDIRECT
190#include <linux/patchkey.h>
191#undef _LINUX_PATCHKEY_H_INDIRECT
192
193#if defined(__KERNEL__)
194# if defined(__BIG_ENDIAN)
195# define AFMT_S16_NE AFMT_S16_BE
196# elif defined(__LITTLE_ENDIAN)
197# define AFMT_S16_NE AFMT_S16_LE
198# else
199# error "could not determine byte order"
200# endif
David Howellsfdc29802011-12-13 15:07:49 +0000201#else
202# if defined(__BYTE_ORDER)
Stuart Brady60d300c2005-05-05 16:15:07 -0700203# if __BYTE_ORDER == __BIG_ENDIAN
204# define AFMT_S16_NE AFMT_S16_BE
205# elif __BYTE_ORDER == __LITTLE_ENDIAN
206# define AFMT_S16_NE AFMT_S16_LE
207# else
208# error "could not determine byte order"
209# endif
David Howellsfdc29802011-12-13 15:07:49 +0000210# endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211#endif
212
213/*
214 * Sample loading mechanism for internal synthesizers (/dev/sequencer)
215 * The following patch_info structure has been designed to support
216 * Gravis UltraSound. It tries to be universal format for uploading
217 * sample based patches but is probably too limited.
218 *
219 * (PBD) As Hannu guessed, the GUS structure is too limited for
220 * the WaveFront, but this is the right place for a constant definition.
221 */
222
223struct patch_info {
224 unsigned short key; /* Use WAVE_PATCH here */
225#define WAVE_PATCH _PATCHKEY(0x04)
226#define GUS_PATCH WAVE_PATCH
227#define WAVEFRONT_PATCH _PATCHKEY(0x06)
228
229 short device_no; /* Synthesizer number */
230 short instr_no; /* Midi pgm# */
231
232 unsigned int mode;
233/*
234 * The least significant byte has the same format than the GUS .PAT
235 * files
236 */
237#define WAVE_16_BITS 0x01 /* bit 0 = 8 or 16 bit wave data. */
238#define WAVE_UNSIGNED 0x02 /* bit 1 = Signed - Unsigned data. */
239#define WAVE_LOOPING 0x04 /* bit 2 = looping enabled-1. */
240#define WAVE_BIDIR_LOOP 0x08 /* bit 3 = Set is bidirectional looping. */
241#define WAVE_LOOP_BACK 0x10 /* bit 4 = Set is looping backward. */
242#define WAVE_SUSTAIN_ON 0x20 /* bit 5 = Turn sustaining on. (Env. pts. 3)*/
243#define WAVE_ENVELOPES 0x40 /* bit 6 = Enable envelopes - 1 */
244#define WAVE_FAST_RELEASE 0x80 /* bit 7 = Shut off immediately after note off */
245 /* (use the env_rate/env_offs fields). */
246/* Linux specific bits */
247#define WAVE_VIBRATO 0x00010000 /* The vibrato info is valid */
248#define WAVE_TREMOLO 0x00020000 /* The tremolo info is valid */
249#define WAVE_SCALE 0x00040000 /* The scaling info is valid */
250#define WAVE_FRACTIONS 0x00080000 /* Fraction information is valid */
251/* Reserved bits */
252#define WAVE_ROM 0x40000000 /* For future use */
253#define WAVE_MULAW 0x20000000 /* For future use */
254/* Other bits must be zeroed */
255
256 int len; /* Size of the wave data in bytes */
257 int loop_start, loop_end; /* Byte offsets from the beginning */
258
259/*
260 * The base_freq and base_note fields are used when computing the
261 * playback speed for a note. The base_note defines the tone frequency
262 * which is heard if the sample is played using the base_freq as the
263 * playback speed.
264 *
265 * The low_note and high_note fields define the minimum and maximum note
266 * frequencies for which this sample is valid. It is possible to define
267 * more than one samples for an instrument number at the same time. The
268 * low_note and high_note fields are used to select the most suitable one.
269 *
270 * The fields base_note, high_note and low_note should contain
271 * the note frequency multiplied by 1000. For example value for the
272 * middle A is 440*1000.
273 */
274
275 unsigned int base_freq;
276 unsigned int base_note;
277 unsigned int high_note;
278 unsigned int low_note;
279 int panning; /* -128=left, 127=right */
280 int detuning;
281
282/* New fields introduced in version 1.99.5 */
283
284 /* Envelope. Enabled by mode bit WAVE_ENVELOPES */
285 unsigned char env_rate[ 6 ]; /* GUS HW ramping rate */
286 unsigned char env_offset[ 6 ]; /* 255 == 100% */
287
288 /*
289 * The tremolo, vibrato and scale info are not supported yet.
290 * Enable by setting the mode bits WAVE_TREMOLO, WAVE_VIBRATO or
291 * WAVE_SCALE
292 */
293
294 unsigned char tremolo_sweep;
295 unsigned char tremolo_rate;
296 unsigned char tremolo_depth;
297
298 unsigned char vibrato_sweep;
299 unsigned char vibrato_rate;
300 unsigned char vibrato_depth;
301
302 int scale_frequency;
303 unsigned int scale_factor; /* from 0 to 2048 or 0 to 2 */
304
305 int volume;
306 int fractions;
307 int reserved1;
308 int spare[2];
309 char data[1]; /* The waveform data starts here */
310 };
311
312struct sysex_info {
313 short key; /* Use SYSEX_PATCH or MAUI_PATCH here */
314#define SYSEX_PATCH _PATCHKEY(0x05)
315#define MAUI_PATCH _PATCHKEY(0x06)
316 short device_no; /* Synthesizer number */
317 int len; /* Size of the sysex data in bytes */
318 unsigned char data[1]; /* Sysex data starts here */
319 };
320
321/*
322 * /dev/sequencer input events.
323 *
324 * The data written to the /dev/sequencer is a stream of events. Events
325 * are records of 4 or 8 bytes. The first byte defines the size.
326 * Any number of events can be written with a write call. There
327 * is a set of macros for sending these events. Use these macros if you
328 * want to maximize portability of your program.
329 *
330 * Events SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO. Are also input events.
331 * (All input events are currently 4 bytes long. Be prepared to support
332 * 8 byte events also. If you receive any event having first byte >= 128,
333 * it's a 8 byte event.
334 *
335 * The events are documented at the end of this file.
336 *
337 * Normal events (4 bytes)
338 * There is also a 8 byte version of most of the 4 byte events. The
339 * 8 byte one is recommended.
340 */
341#define SEQ_NOTEOFF 0
342#define SEQ_FMNOTEOFF SEQ_NOTEOFF /* Just old name */
343#define SEQ_NOTEON 1
344#define SEQ_FMNOTEON SEQ_NOTEON
345#define SEQ_WAIT TMR_WAIT_ABS
346#define SEQ_PGMCHANGE 3
347#define SEQ_FMPGMCHANGE SEQ_PGMCHANGE
348#define SEQ_SYNCTIMER TMR_START
349#define SEQ_MIDIPUTC 5
350#define SEQ_DRUMON 6 /*** OBSOLETE ***/
351#define SEQ_DRUMOFF 7 /*** OBSOLETE ***/
352#define SEQ_ECHO TMR_ECHO /* For synching programs with output */
353#define SEQ_AFTERTOUCH 9
354#define SEQ_CONTROLLER 10
355
356/*******************************************
357 * Midi controller numbers
358 *******************************************
359 * Controllers 0 to 31 (0x00 to 0x1f) and
360 * 32 to 63 (0x20 to 0x3f) are continuous
361 * controllers.
362 * In the MIDI 1.0 these controllers are sent using
363 * two messages. Controller numbers 0 to 31 are used
364 * to send the MSB and the controller numbers 32 to 63
365 * are for the LSB. Note that just 7 bits are used in MIDI bytes.
366 */
367
368#define CTL_BANK_SELECT 0x00
369#define CTL_MODWHEEL 0x01
370#define CTL_BREATH 0x02
371/* undefined 0x03 */
372#define CTL_FOOT 0x04
373#define CTL_PORTAMENTO_TIME 0x05
374#define CTL_DATA_ENTRY 0x06
375#define CTL_MAIN_VOLUME 0x07
376#define CTL_BALANCE 0x08
377/* undefined 0x09 */
378#define CTL_PAN 0x0a
379#define CTL_EXPRESSION 0x0b
380/* undefined 0x0c */
381/* undefined 0x0d */
382/* undefined 0x0e */
383/* undefined 0x0f */
384#define CTL_GENERAL_PURPOSE1 0x10
385#define CTL_GENERAL_PURPOSE2 0x11
386#define CTL_GENERAL_PURPOSE3 0x12
387#define CTL_GENERAL_PURPOSE4 0x13
388/* undefined 0x14 - 0x1f */
389
390/* undefined 0x20 */
391/* The controller numbers 0x21 to 0x3f are reserved for the */
392/* least significant bytes of the controllers 0x00 to 0x1f. */
393/* These controllers are not recognised by the driver. */
394
395/* Controllers 64 to 69 (0x40 to 0x45) are on/off switches. */
396/* 0=OFF and 127=ON (intermediate values are possible) */
397#define CTL_DAMPER_PEDAL 0x40
398#define CTL_SUSTAIN 0x40 /* Alias */
399#define CTL_HOLD 0x40 /* Alias */
400#define CTL_PORTAMENTO 0x41
401#define CTL_SOSTENUTO 0x42
402#define CTL_SOFT_PEDAL 0x43
403/* undefined 0x44 */
404#define CTL_HOLD2 0x45
405/* undefined 0x46 - 0x4f */
406
407#define CTL_GENERAL_PURPOSE5 0x50
408#define CTL_GENERAL_PURPOSE6 0x51
409#define CTL_GENERAL_PURPOSE7 0x52
410#define CTL_GENERAL_PURPOSE8 0x53
411/* undefined 0x54 - 0x5a */
412#define CTL_EXT_EFF_DEPTH 0x5b
413#define CTL_TREMOLO_DEPTH 0x5c
414#define CTL_CHORUS_DEPTH 0x5d
415#define CTL_DETUNE_DEPTH 0x5e
416#define CTL_CELESTE_DEPTH 0x5e /* Alias for the above one */
417#define CTL_PHASER_DEPTH 0x5f
418#define CTL_DATA_INCREMENT 0x60
419#define CTL_DATA_DECREMENT 0x61
420#define CTL_NONREG_PARM_NUM_LSB 0x62
421#define CTL_NONREG_PARM_NUM_MSB 0x63
422#define CTL_REGIST_PARM_NUM_LSB 0x64
423#define CTL_REGIST_PARM_NUM_MSB 0x65
424/* undefined 0x66 - 0x78 */
425/* reserved 0x79 - 0x7f */
426
427/* Pseudo controllers (not midi compatible) */
428#define CTRL_PITCH_BENDER 255
429#define CTRL_PITCH_BENDER_RANGE 254
430#define CTRL_EXPRESSION 253 /* Obsolete */
431#define CTRL_MAIN_VOLUME 252 /* Obsolete */
432#define SEQ_BALANCE 11
433#define SEQ_VOLMODE 12
434
435/*
436 * Volume mode decides how volumes are used
437 */
438
439#define VOL_METHOD_ADAGIO 1
440#define VOL_METHOD_LINEAR 2
441
442/*
443 * Note! SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO are used also as
444 * input events.
445 */
446
447/*
448 * Event codes 0xf0 to 0xfc are reserved for future extensions.
449 */
450
451#define SEQ_FULLSIZE 0xfd /* Long events */
452/*
453 * SEQ_FULLSIZE events are used for loading patches/samples to the
454 * synthesizer devices. These events are passed directly to the driver
455 * of the associated synthesizer device. There is no limit to the size
456 * of the extended events. These events are not queued but executed
457 * immediately when the write() is called (execution can take several
458 * seconds of time).
459 *
460 * When a SEQ_FULLSIZE message is written to the device, it must
461 * be written using exactly one write() call. Other events cannot
462 * be mixed to the same write.
463 *
464 * For FM synths (YM3812/OPL3) use struct sbi_instrument and write it to the
465 * /dev/sequencer. Don't write other data together with the instrument structure
466 * Set the key field of the structure to FM_PATCH. The device field is used to
467 * route the patch to the corresponding device.
468 *
469 * For wave table use struct patch_info. Initialize the key field
470 * to WAVE_PATCH.
471 */
472#define SEQ_PRIVATE 0xfe /* Low level HW dependent events (8 bytes) */
473#define SEQ_EXTENDED 0xff /* Extended events (8 bytes) OBSOLETE */
474
475/*
476 * Record for FM patches
477 */
478
479typedef unsigned char sbi_instr_data[32];
480
481struct sbi_instrument {
482 unsigned short key; /* FM_PATCH or OPL3_PATCH */
483#define FM_PATCH _PATCHKEY(0x01)
484#define OPL3_PATCH _PATCHKEY(0x03)
485 short device; /* Synth# (0-4) */
486 int channel; /* Program# to be initialized */
487 sbi_instr_data operators; /* Register settings for operator cells (.SBI format) */
488 };
489
490struct synth_info { /* Read only */
491 char name[30];
492 int device; /* 0-N. INITIALIZE BEFORE CALLING */
493 int synth_type;
494#define SYNTH_TYPE_FM 0
495#define SYNTH_TYPE_SAMPLE 1
496#define SYNTH_TYPE_MIDI 2 /* Midi interface */
497
498 int synth_subtype;
499#define FM_TYPE_ADLIB 0x00
500#define FM_TYPE_OPL3 0x01
501#define MIDI_TYPE_MPU401 0x401
502
503#define SAMPLE_TYPE_BASIC 0x10
504#define SAMPLE_TYPE_GUS SAMPLE_TYPE_BASIC
505#define SAMPLE_TYPE_WAVEFRONT 0x11
506
507 int perc_mode; /* No longer supported */
508 int nr_voices;
509 int nr_drums; /* Obsolete field */
510 int instr_bank_size;
511 unsigned int capabilities;
512#define SYNTH_CAP_PERCMODE 0x00000001 /* No longer used */
513#define SYNTH_CAP_OPL3 0x00000002 /* Set if OPL3 supported */
514#define SYNTH_CAP_INPUT 0x00000004 /* Input (MIDI) device */
515 int dummies[19]; /* Reserve space */
516 };
517
518struct sound_timer_info {
519 char name[32];
520 int caps;
521 };
522
523#define MIDI_CAP_MPU401 1 /* MPU-401 intelligent mode */
524
525struct midi_info {
526 char name[30];
527 int device; /* 0-N. INITIALIZE BEFORE CALLING */
528 unsigned int capabilities; /* To be defined later */
529 int dev_type;
530 int dummies[18]; /* Reserve space */
531 };
532
533/********************************************
534 * ioctl commands for the /dev/midi##
535 */
536typedef struct {
537 unsigned char cmd;
538 char nr_args, nr_returns;
539 unsigned char data[30];
540 } mpu_command_rec;
541
542#define SNDCTL_MIDI_PRETIME _SIOWR('m', 0, int)
543#define SNDCTL_MIDI_MPUMODE _SIOWR('m', 1, int)
544#define SNDCTL_MIDI_MPUCMD _SIOWR('m', 2, mpu_command_rec)
545
546/********************************************
547 * IOCTL commands for /dev/dsp and /dev/audio
548 */
549
550#define SNDCTL_DSP_RESET _SIO ('P', 0)
551#define SNDCTL_DSP_SYNC _SIO ('P', 1)
552#define SNDCTL_DSP_SPEED _SIOWR('P', 2, int)
553#define SNDCTL_DSP_STEREO _SIOWR('P', 3, int)
554#define SNDCTL_DSP_GETBLKSIZE _SIOWR('P', 4, int)
555#define SNDCTL_DSP_SAMPLESIZE SNDCTL_DSP_SETFMT
556#define SNDCTL_DSP_CHANNELS _SIOWR('P', 6, int)
557#define SOUND_PCM_WRITE_CHANNELS SNDCTL_DSP_CHANNELS
558#define SOUND_PCM_WRITE_FILTER _SIOWR('P', 7, int)
559#define SNDCTL_DSP_POST _SIO ('P', 8)
560#define SNDCTL_DSP_SUBDIVIDE _SIOWR('P', 9, int)
561#define SNDCTL_DSP_SETFRAGMENT _SIOWR('P',10, int)
562
563/* Audio data formats (Note! U8=8 and S16_LE=16 for compatibility) */
564#define SNDCTL_DSP_GETFMTS _SIOR ('P',11, int) /* Returns a mask */
565#define SNDCTL_DSP_SETFMT _SIOWR('P',5, int) /* Selects ONE fmt*/
566# define AFMT_QUERY 0x00000000 /* Return current fmt */
567# define AFMT_MU_LAW 0x00000001
568# define AFMT_A_LAW 0x00000002
569# define AFMT_IMA_ADPCM 0x00000004
570# define AFMT_U8 0x00000008
571# define AFMT_S16_LE 0x00000010 /* Little endian signed 16*/
572# define AFMT_S16_BE 0x00000020 /* Big endian signed 16 */
573# define AFMT_S8 0x00000040
574# define AFMT_U16_LE 0x00000080 /* Little endian U16 */
575# define AFMT_U16_BE 0x00000100 /* Big endian U16 */
576# define AFMT_MPEG 0x00000200 /* MPEG (2) audio */
577# define AFMT_AC3 0x00000400 /* Dolby Digital AC3 */
578
579/*
580 * Buffer status queries.
581 */
582typedef struct audio_buf_info {
583 int fragments; /* # of available fragments (partially usend ones not counted) */
584 int fragstotal; /* Total # of fragments allocated */
585 int fragsize; /* Size of a fragment in bytes */
586
587 int bytes; /* Available space in bytes (includes partially used fragments) */
588 /* Note! 'bytes' could be more than fragments*fragsize */
589 } audio_buf_info;
590
591#define SNDCTL_DSP_GETOSPACE _SIOR ('P',12, audio_buf_info)
592#define SNDCTL_DSP_GETISPACE _SIOR ('P',13, audio_buf_info)
593#define SNDCTL_DSP_NONBLOCK _SIO ('P',14)
594#define SNDCTL_DSP_GETCAPS _SIOR ('P',15, int)
595# define DSP_CAP_REVISION 0x000000ff /* Bits for revision level (0 to 255) */
596# define DSP_CAP_DUPLEX 0x00000100 /* Full duplex record/playback */
597# define DSP_CAP_REALTIME 0x00000200 /* Real time capability */
598# define DSP_CAP_BATCH 0x00000400 /* Device has some kind of */
599 /* internal buffers which may */
600 /* cause some delays and */
601 /* decrease precision of timing */
602# define DSP_CAP_COPROC 0x00000800 /* Has a coprocessor */
603 /* Sometimes it's a DSP */
604 /* but usually not */
605# define DSP_CAP_TRIGGER 0x00001000 /* Supports SETTRIGGER */
606# define DSP_CAP_MMAP 0x00002000 /* Supports mmap() */
607# define DSP_CAP_MULTI 0x00004000 /* support multiple open */
608# define DSP_CAP_BIND 0x00008000 /* channel binding to front/rear/cneter/lfe */
609
610
611#define SNDCTL_DSP_GETTRIGGER _SIOR ('P',16, int)
612#define SNDCTL_DSP_SETTRIGGER _SIOW ('P',16, int)
613# define PCM_ENABLE_INPUT 0x00000001
614# define PCM_ENABLE_OUTPUT 0x00000002
615
616typedef struct count_info {
617 int bytes; /* Total # of bytes processed */
618 int blocks; /* # of fragment transitions since last time */
619 int ptr; /* Current DMA pointer value */
620 } count_info;
621
622#define SNDCTL_DSP_GETIPTR _SIOR ('P',17, count_info)
623#define SNDCTL_DSP_GETOPTR _SIOR ('P',18, count_info)
624
625typedef struct buffmem_desc {
626 unsigned *buffer;
627 int size;
628 } buffmem_desc;
629#define SNDCTL_DSP_MAPINBUF _SIOR ('P', 19, buffmem_desc)
630#define SNDCTL_DSP_MAPOUTBUF _SIOR ('P', 20, buffmem_desc)
631#define SNDCTL_DSP_SETSYNCRO _SIO ('P', 21)
632#define SNDCTL_DSP_SETDUPLEX _SIO ('P', 22)
633#define SNDCTL_DSP_GETODELAY _SIOR ('P', 23, int)
634
635#define SNDCTL_DSP_GETCHANNELMASK _SIOWR('P', 64, int)
636#define SNDCTL_DSP_BIND_CHANNEL _SIOWR('P', 65, int)
637# define DSP_BIND_QUERY 0x00000000
638# define DSP_BIND_FRONT 0x00000001
639# define DSP_BIND_SURR 0x00000002
640# define DSP_BIND_CENTER_LFE 0x00000004
641# define DSP_BIND_HANDSET 0x00000008
642# define DSP_BIND_MIC 0x00000010
643# define DSP_BIND_MODEM1 0x00000020
644# define DSP_BIND_MODEM2 0x00000040
645# define DSP_BIND_I2S 0x00000080
646# define DSP_BIND_SPDIF 0x00000100
647
648#define SNDCTL_DSP_SETSPDIF _SIOW ('P', 66, int)
649#define SNDCTL_DSP_GETSPDIF _SIOR ('P', 67, int)
650# define SPDIF_PRO 0x0001
651# define SPDIF_N_AUD 0x0002
652# define SPDIF_COPY 0x0004
653# define SPDIF_PRE 0x0008
654# define SPDIF_CC 0x07f0
655# define SPDIF_L 0x0800
656# define SPDIF_DRS 0x4000
657# define SPDIF_V 0x8000
658
659/*
660 * Application's profile defines the way how playback underrun situations should be handled.
661 *
662 * APF_NORMAL (the default) and APF_NETWORK make the driver to cleanup the
663 * playback buffer whenever an underrun occurs. This consumes some time
664 * prevents looping the existing buffer.
665 * APF_CPUINTENS is intended to be set by CPU intensive applications which
666 * are likely to run out of time occasionally. In this mode the buffer cleanup is
667 * disabled which saves CPU time but also let's the previous buffer content to
668 * be played during the "pause" after the underrun.
669 */
670#define SNDCTL_DSP_PROFILE _SIOW ('P', 23, int)
671#define APF_NORMAL 0 /* Normal applications */
672#define APF_NETWORK 1 /* Underruns probably caused by an "external" delay */
673#define APF_CPUINTENS 2 /* Underruns probably caused by "overheating" the CPU */
674
675#define SOUND_PCM_READ_RATE _SIOR ('P', 2, int)
676#define SOUND_PCM_READ_CHANNELS _SIOR ('P', 6, int)
677#define SOUND_PCM_READ_BITS _SIOR ('P', 5, int)
678#define SOUND_PCM_READ_FILTER _SIOR ('P', 7, int)
679
680/* Some alias names */
681#define SOUND_PCM_WRITE_BITS SNDCTL_DSP_SETFMT
682#define SOUND_PCM_WRITE_RATE SNDCTL_DSP_SPEED
683#define SOUND_PCM_POST SNDCTL_DSP_POST
684#define SOUND_PCM_RESET SNDCTL_DSP_RESET
685#define SOUND_PCM_SYNC SNDCTL_DSP_SYNC
686#define SOUND_PCM_SUBDIVIDE SNDCTL_DSP_SUBDIVIDE
687#define SOUND_PCM_SETFRAGMENT SNDCTL_DSP_SETFRAGMENT
688#define SOUND_PCM_GETFMTS SNDCTL_DSP_GETFMTS
689#define SOUND_PCM_SETFMT SNDCTL_DSP_SETFMT
690#define SOUND_PCM_GETOSPACE SNDCTL_DSP_GETOSPACE
691#define SOUND_PCM_GETISPACE SNDCTL_DSP_GETISPACE
692#define SOUND_PCM_NONBLOCK SNDCTL_DSP_NONBLOCK
693#define SOUND_PCM_GETCAPS SNDCTL_DSP_GETCAPS
694#define SOUND_PCM_GETTRIGGER SNDCTL_DSP_GETTRIGGER
695#define SOUND_PCM_SETTRIGGER SNDCTL_DSP_SETTRIGGER
696#define SOUND_PCM_SETSYNCRO SNDCTL_DSP_SETSYNCRO
697#define SOUND_PCM_GETIPTR SNDCTL_DSP_GETIPTR
698#define SOUND_PCM_GETOPTR SNDCTL_DSP_GETOPTR
699#define SOUND_PCM_MAPINBUF SNDCTL_DSP_MAPINBUF
700#define SOUND_PCM_MAPOUTBUF SNDCTL_DSP_MAPOUTBUF
701
702/*
703 * ioctl calls to be used in communication with coprocessors and
704 * DSP chips.
705 */
706
707typedef struct copr_buffer {
708 int command; /* Set to 0 if not used */
709 int flags;
710#define CPF_NONE 0x0000
711#define CPF_FIRST 0x0001 /* First block */
712#define CPF_LAST 0x0002 /* Last block */
713 int len;
714 int offs; /* If required by the device (0 if not used) */
715
716 unsigned char data[4000]; /* NOTE! 4000 is not 4k */
717 } copr_buffer;
718
719typedef struct copr_debug_buf {
720 int command; /* Used internally. Set to 0 */
721 int parm1;
722 int parm2;
723 int flags;
724 int len; /* Length of data in bytes */
725 } copr_debug_buf;
726
727typedef struct copr_msg {
728 int len;
729 unsigned char data[4000];
730 } copr_msg;
731
732#define SNDCTL_COPR_RESET _SIO ('C', 0)
733#define SNDCTL_COPR_LOAD _SIOWR('C', 1, copr_buffer)
734#define SNDCTL_COPR_RDATA _SIOWR('C', 2, copr_debug_buf)
735#define SNDCTL_COPR_RCODE _SIOWR('C', 3, copr_debug_buf)
736#define SNDCTL_COPR_WDATA _SIOW ('C', 4, copr_debug_buf)
737#define SNDCTL_COPR_WCODE _SIOW ('C', 5, copr_debug_buf)
738#define SNDCTL_COPR_RUN _SIOWR('C', 6, copr_debug_buf)
739#define SNDCTL_COPR_HALT _SIOWR('C', 7, copr_debug_buf)
740#define SNDCTL_COPR_SENDMSG _SIOWR('C', 8, copr_msg)
741#define SNDCTL_COPR_RCVMSG _SIOR ('C', 9, copr_msg)
742
743/*********************************************
744 * IOCTL commands for /dev/mixer
745 */
746
747/*
748 * Mixer devices
749 *
750 * There can be up to 20 different analog mixer channels. The
751 * SOUND_MIXER_NRDEVICES gives the currently supported maximum.
752 * The SOUND_MIXER_READ_DEVMASK returns a bitmask which tells
753 * the devices supported by the particular mixer.
754 */
755
756#define SOUND_MIXER_NRDEVICES 25
757#define SOUND_MIXER_VOLUME 0
758#define SOUND_MIXER_BASS 1
759#define SOUND_MIXER_TREBLE 2
760#define SOUND_MIXER_SYNTH 3
761#define SOUND_MIXER_PCM 4
762#define SOUND_MIXER_SPEAKER 5
763#define SOUND_MIXER_LINE 6
764#define SOUND_MIXER_MIC 7
765#define SOUND_MIXER_CD 8
766#define SOUND_MIXER_IMIX 9 /* Recording monitor */
767#define SOUND_MIXER_ALTPCM 10
768#define SOUND_MIXER_RECLEV 11 /* Recording level */
769#define SOUND_MIXER_IGAIN 12 /* Input gain */
770#define SOUND_MIXER_OGAIN 13 /* Output gain */
771/*
772 * The AD1848 codec and compatibles have three line level inputs
773 * (line, aux1 and aux2). Since each card manufacturer have assigned
774 * different meanings to these inputs, it's inpractical to assign
775 * specific meanings (line, cd, synth etc.) to them.
776 */
777#define SOUND_MIXER_LINE1 14 /* Input source 1 (aux1) */
778#define SOUND_MIXER_LINE2 15 /* Input source 2 (aux2) */
779#define SOUND_MIXER_LINE3 16 /* Input source 3 (line) */
780#define SOUND_MIXER_DIGITAL1 17 /* Digital (input) 1 */
781#define SOUND_MIXER_DIGITAL2 18 /* Digital (input) 2 */
782#define SOUND_MIXER_DIGITAL3 19 /* Digital (input) 3 */
783#define SOUND_MIXER_PHONEIN 20 /* Phone input */
784#define SOUND_MIXER_PHONEOUT 21 /* Phone output */
785#define SOUND_MIXER_VIDEO 22 /* Video/TV (audio) in */
786#define SOUND_MIXER_RADIO 23 /* Radio in */
787#define SOUND_MIXER_MONITOR 24 /* Monitor (usually mic) volume */
788
789/* Some on/off settings (SOUND_SPECIAL_MIN - SOUND_SPECIAL_MAX) */
790/* Not counted to SOUND_MIXER_NRDEVICES, but use the same number space */
791#define SOUND_ONOFF_MIN 28
792#define SOUND_ONOFF_MAX 30
793
794/* Note! Number 31 cannot be used since the sign bit is reserved */
795#define SOUND_MIXER_NONE 31
796
797/*
798 * The following unsupported macros are no longer functional.
799 * Use SOUND_MIXER_PRIVATE# macros in future.
800 */
801#define SOUND_MIXER_ENHANCE SOUND_MIXER_NONE
802#define SOUND_MIXER_MUTE SOUND_MIXER_NONE
803#define SOUND_MIXER_LOUD SOUND_MIXER_NONE
804
805
806#define SOUND_DEVICE_LABELS {"Vol ", "Bass ", "Trebl", "Synth", "Pcm ", "Spkr ", "Line ", \
807 "Mic ", "CD ", "Mix ", "Pcm2 ", "Rec ", "IGain", "OGain", \
808 "Line1", "Line2", "Line3", "Digital1", "Digital2", "Digital3", \
809 "PhoneIn", "PhoneOut", "Video", "Radio", "Monitor"}
810
811#define SOUND_DEVICE_NAMES {"vol", "bass", "treble", "synth", "pcm", "speaker", "line", \
812 "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", \
813 "line1", "line2", "line3", "dig1", "dig2", "dig3", \
814 "phin", "phout", "video", "radio", "monitor"}
815
816/* Device bitmask identifiers */
817
818#define SOUND_MIXER_RECSRC 0xff /* Arg contains a bit for each recording source */
819#define SOUND_MIXER_DEVMASK 0xfe /* Arg contains a bit for each supported device */
820#define SOUND_MIXER_RECMASK 0xfd /* Arg contains a bit for each supported recording source */
821#define SOUND_MIXER_CAPS 0xfc
822# define SOUND_CAP_EXCL_INPUT 0x00000001 /* Only one recording source at a time */
823#define SOUND_MIXER_STEREODEVS 0xfb /* Mixer channels supporting stereo */
824#define SOUND_MIXER_OUTSRC 0xfa /* Arg contains a bit for each input source to output */
825#define SOUND_MIXER_OUTMASK 0xf9 /* Arg contains a bit for each supported input source to output */
826
827/* Device mask bits */
828
829#define SOUND_MASK_VOLUME (1 << SOUND_MIXER_VOLUME)
830#define SOUND_MASK_BASS (1 << SOUND_MIXER_BASS)
831#define SOUND_MASK_TREBLE (1 << SOUND_MIXER_TREBLE)
832#define SOUND_MASK_SYNTH (1 << SOUND_MIXER_SYNTH)
833#define SOUND_MASK_PCM (1 << SOUND_MIXER_PCM)
834#define SOUND_MASK_SPEAKER (1 << SOUND_MIXER_SPEAKER)
835#define SOUND_MASK_LINE (1 << SOUND_MIXER_LINE)
836#define SOUND_MASK_MIC (1 << SOUND_MIXER_MIC)
837#define SOUND_MASK_CD (1 << SOUND_MIXER_CD)
838#define SOUND_MASK_IMIX (1 << SOUND_MIXER_IMIX)
839#define SOUND_MASK_ALTPCM (1 << SOUND_MIXER_ALTPCM)
840#define SOUND_MASK_RECLEV (1 << SOUND_MIXER_RECLEV)
841#define SOUND_MASK_IGAIN (1 << SOUND_MIXER_IGAIN)
842#define SOUND_MASK_OGAIN (1 << SOUND_MIXER_OGAIN)
843#define SOUND_MASK_LINE1 (1 << SOUND_MIXER_LINE1)
844#define SOUND_MASK_LINE2 (1 << SOUND_MIXER_LINE2)
845#define SOUND_MASK_LINE3 (1 << SOUND_MIXER_LINE3)
846#define SOUND_MASK_DIGITAL1 (1 << SOUND_MIXER_DIGITAL1)
847#define SOUND_MASK_DIGITAL2 (1 << SOUND_MIXER_DIGITAL2)
848#define SOUND_MASK_DIGITAL3 (1 << SOUND_MIXER_DIGITAL3)
849#define SOUND_MASK_PHONEIN (1 << SOUND_MIXER_PHONEIN)
850#define SOUND_MASK_PHONEOUT (1 << SOUND_MIXER_PHONEOUT)
851#define SOUND_MASK_RADIO (1 << SOUND_MIXER_RADIO)
852#define SOUND_MASK_VIDEO (1 << SOUND_MIXER_VIDEO)
853#define SOUND_MASK_MONITOR (1 << SOUND_MIXER_MONITOR)
854
855/* Obsolete macros */
856#define SOUND_MASK_MUTE (1 << SOUND_MIXER_MUTE)
857#define SOUND_MASK_ENHANCE (1 << SOUND_MIXER_ENHANCE)
858#define SOUND_MASK_LOUD (1 << SOUND_MIXER_LOUD)
859
860#define MIXER_READ(dev) _SIOR('M', dev, int)
861#define SOUND_MIXER_READ_VOLUME MIXER_READ(SOUND_MIXER_VOLUME)
862#define SOUND_MIXER_READ_BASS MIXER_READ(SOUND_MIXER_BASS)
863#define SOUND_MIXER_READ_TREBLE MIXER_READ(SOUND_MIXER_TREBLE)
864#define SOUND_MIXER_READ_SYNTH MIXER_READ(SOUND_MIXER_SYNTH)
865#define SOUND_MIXER_READ_PCM MIXER_READ(SOUND_MIXER_PCM)
866#define SOUND_MIXER_READ_SPEAKER MIXER_READ(SOUND_MIXER_SPEAKER)
867#define SOUND_MIXER_READ_LINE MIXER_READ(SOUND_MIXER_LINE)
868#define SOUND_MIXER_READ_MIC MIXER_READ(SOUND_MIXER_MIC)
869#define SOUND_MIXER_READ_CD MIXER_READ(SOUND_MIXER_CD)
870#define SOUND_MIXER_READ_IMIX MIXER_READ(SOUND_MIXER_IMIX)
871#define SOUND_MIXER_READ_ALTPCM MIXER_READ(SOUND_MIXER_ALTPCM)
872#define SOUND_MIXER_READ_RECLEV MIXER_READ(SOUND_MIXER_RECLEV)
873#define SOUND_MIXER_READ_IGAIN MIXER_READ(SOUND_MIXER_IGAIN)
874#define SOUND_MIXER_READ_OGAIN MIXER_READ(SOUND_MIXER_OGAIN)
875#define SOUND_MIXER_READ_LINE1 MIXER_READ(SOUND_MIXER_LINE1)
876#define SOUND_MIXER_READ_LINE2 MIXER_READ(SOUND_MIXER_LINE2)
877#define SOUND_MIXER_READ_LINE3 MIXER_READ(SOUND_MIXER_LINE3)
878
879/* Obsolete macros */
880#define SOUND_MIXER_READ_MUTE MIXER_READ(SOUND_MIXER_MUTE)
881#define SOUND_MIXER_READ_ENHANCE MIXER_READ(SOUND_MIXER_ENHANCE)
882#define SOUND_MIXER_READ_LOUD MIXER_READ(SOUND_MIXER_LOUD)
883
884#define SOUND_MIXER_READ_RECSRC MIXER_READ(SOUND_MIXER_RECSRC)
885#define SOUND_MIXER_READ_DEVMASK MIXER_READ(SOUND_MIXER_DEVMASK)
886#define SOUND_MIXER_READ_RECMASK MIXER_READ(SOUND_MIXER_RECMASK)
887#define SOUND_MIXER_READ_STEREODEVS MIXER_READ(SOUND_MIXER_STEREODEVS)
888#define SOUND_MIXER_READ_CAPS MIXER_READ(SOUND_MIXER_CAPS)
889
890#define MIXER_WRITE(dev) _SIOWR('M', dev, int)
891#define SOUND_MIXER_WRITE_VOLUME MIXER_WRITE(SOUND_MIXER_VOLUME)
892#define SOUND_MIXER_WRITE_BASS MIXER_WRITE(SOUND_MIXER_BASS)
893#define SOUND_MIXER_WRITE_TREBLE MIXER_WRITE(SOUND_MIXER_TREBLE)
894#define SOUND_MIXER_WRITE_SYNTH MIXER_WRITE(SOUND_MIXER_SYNTH)
895#define SOUND_MIXER_WRITE_PCM MIXER_WRITE(SOUND_MIXER_PCM)
896#define SOUND_MIXER_WRITE_SPEAKER MIXER_WRITE(SOUND_MIXER_SPEAKER)
897#define SOUND_MIXER_WRITE_LINE MIXER_WRITE(SOUND_MIXER_LINE)
898#define SOUND_MIXER_WRITE_MIC MIXER_WRITE(SOUND_MIXER_MIC)
899#define SOUND_MIXER_WRITE_CD MIXER_WRITE(SOUND_MIXER_CD)
900#define SOUND_MIXER_WRITE_IMIX MIXER_WRITE(SOUND_MIXER_IMIX)
901#define SOUND_MIXER_WRITE_ALTPCM MIXER_WRITE(SOUND_MIXER_ALTPCM)
902#define SOUND_MIXER_WRITE_RECLEV MIXER_WRITE(SOUND_MIXER_RECLEV)
903#define SOUND_MIXER_WRITE_IGAIN MIXER_WRITE(SOUND_MIXER_IGAIN)
904#define SOUND_MIXER_WRITE_OGAIN MIXER_WRITE(SOUND_MIXER_OGAIN)
905#define SOUND_MIXER_WRITE_LINE1 MIXER_WRITE(SOUND_MIXER_LINE1)
906#define SOUND_MIXER_WRITE_LINE2 MIXER_WRITE(SOUND_MIXER_LINE2)
907#define SOUND_MIXER_WRITE_LINE3 MIXER_WRITE(SOUND_MIXER_LINE3)
908
909/* Obsolete macros */
910#define SOUND_MIXER_WRITE_MUTE MIXER_WRITE(SOUND_MIXER_MUTE)
911#define SOUND_MIXER_WRITE_ENHANCE MIXER_WRITE(SOUND_MIXER_ENHANCE)
912#define SOUND_MIXER_WRITE_LOUD MIXER_WRITE(SOUND_MIXER_LOUD)
913
914#define SOUND_MIXER_WRITE_RECSRC MIXER_WRITE(SOUND_MIXER_RECSRC)
915
916typedef struct mixer_info
917{
918 char id[16];
919 char name[32];
920 int modify_counter;
921 int fillers[10];
922} mixer_info;
923
924typedef struct _old_mixer_info /* Obsolete */
925{
926 char id[16];
927 char name[32];
928} _old_mixer_info;
929
930#define SOUND_MIXER_INFO _SIOR ('M', 101, mixer_info)
931#define SOUND_OLD_MIXER_INFO _SIOR ('M', 101, _old_mixer_info)
932
933/*
934 * A mechanism for accessing "proprietary" mixer features. This method
935 * permits passing 128 bytes of arbitrary data between a mixer application
936 * and the mixer driver. Interpretation of the record is defined by
937 * the particular mixer driver.
938 */
939typedef unsigned char mixer_record[128];
940
941#define SOUND_MIXER_ACCESS _SIOWR('M', 102, mixer_record)
942
943/*
944 * Two ioctls for special souncard function
945 */
946#define SOUND_MIXER_AGC _SIOWR('M', 103, int)
947#define SOUND_MIXER_3DSE _SIOWR('M', 104, int)
948
949/*
950 * The SOUND_MIXER_PRIVATE# commands can be redefined by low level drivers.
951 * These features can be used when accessing device specific features.
952 */
953#define SOUND_MIXER_PRIVATE1 _SIOWR('M', 111, int)
954#define SOUND_MIXER_PRIVATE2 _SIOWR('M', 112, int)
955#define SOUND_MIXER_PRIVATE3 _SIOWR('M', 113, int)
956#define SOUND_MIXER_PRIVATE4 _SIOWR('M', 114, int)
957#define SOUND_MIXER_PRIVATE5 _SIOWR('M', 115, int)
958
959/*
960 * SOUND_MIXER_GETLEVELS and SOUND_MIXER_SETLEVELS calls can be used
961 * for querying current mixer settings from the driver and for loading
962 * default volume settings _prior_ activating the mixer (loading
963 * doesn't affect current state of the mixer hardware). These calls
964 * are for internal use only.
965 */
966
967typedef struct mixer_vol_table {
968 int num; /* Index to volume table */
969 char name[32];
970 int levels[32];
971} mixer_vol_table;
972
973#define SOUND_MIXER_GETLEVELS _SIOWR('M', 116, mixer_vol_table)
974#define SOUND_MIXER_SETLEVELS _SIOWR('M', 117, mixer_vol_table)
975
976/*
977 * An ioctl for identifying the driver version. It will return value
978 * of the SOUND_VERSION macro used when compiling the driver.
979 * This call was introduced in OSS version 3.6 and it will not work
980 * with earlier versions (returns EINVAL).
981 */
982#define OSS_GETVERSION _SIOR ('M', 118, int)
983
984/*
985 * Level 2 event types for /dev/sequencer
986 */
987
988/*
989 * The 4 most significant bits of byte 0 specify the class of
990 * the event:
991 *
992 * 0x8X = system level events,
993 * 0x9X = device/port specific events, event[1] = device/port,
994 * The last 4 bits give the subtype:
995 * 0x02 = Channel event (event[3] = chn).
996 * 0x01 = note event (event[4] = note).
997 * (0x01 is not used alone but always with bit 0x02).
998 * event[2] = MIDI message code (0x80=note off etc.)
999 *
1000 */
1001
1002#define EV_SEQ_LOCAL 0x80
1003#define EV_TIMING 0x81
1004#define EV_CHN_COMMON 0x92
1005#define EV_CHN_VOICE 0x93
1006#define EV_SYSEX 0x94
1007/*
1008 * Event types 200 to 220 are reserved for application use.
1009 * These numbers will not be used by the driver.
1010 */
1011
1012/*
1013 * Events for event type EV_CHN_VOICE
1014 */
1015
1016#define MIDI_NOTEOFF 0x80
1017#define MIDI_NOTEON 0x90
1018#define MIDI_KEY_PRESSURE 0xA0
1019
1020/*
1021 * Events for event type EV_CHN_COMMON
1022 */
1023
1024#define MIDI_CTL_CHANGE 0xB0
1025#define MIDI_PGM_CHANGE 0xC0
1026#define MIDI_CHN_PRESSURE 0xD0
1027#define MIDI_PITCH_BEND 0xE0
1028
1029#define MIDI_SYSTEM_PREFIX 0xF0
1030
1031/*
1032 * Timer event types
1033 */
1034#define TMR_WAIT_REL 1 /* Time relative to the prev time */
1035#define TMR_WAIT_ABS 2 /* Absolute time since TMR_START */
1036#define TMR_STOP 3
1037#define TMR_START 4
1038#define TMR_CONTINUE 5
1039#define TMR_TEMPO 6
1040#define TMR_ECHO 8
1041#define TMR_CLOCK 9 /* MIDI clock */
1042#define TMR_SPP 10 /* Song position pointer */
1043#define TMR_TIMESIG 11 /* Time signature */
1044
1045/*
1046 * Local event types
1047 */
1048#define LOCL_STARTAUDIO 1
1049
Arnd Bergmann43a99072009-02-10 00:00:22 +01001050#if !defined(__KERNEL__) || defined(USE_SEQ_MACROS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051/*
1052 * Some convenience macros to simplify programming of the
1053 * /dev/sequencer interface
1054 *
Arnd Bergmann43a99072009-02-10 00:00:22 +01001055 * This is a legacy interface for applications written against
1056 * the OSSlib-3.8 style interface. It is no longer possible
1057 * to actually link against OSSlib with this header, but we
1058 * still provide these macros for programs using them.
1059 *
1060 * If you want to use OSSlib, it is recommended that you get
1061 * the GPL version of OSS-4.x and build against that version
1062 * of the header.
1063 *
1064 * We redefine the extern keyword so that make headers_check
1065 * does not complain about SEQ_USE_EXTBUF.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 */
1067#define SEQ_DECLAREBUF() SEQ_USE_EXTBUF()
1068
1069void seqbuf_dump(void); /* This function must be provided by programs */
1070
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071#define SEQ_PM_DEFINES int __foo_bar___
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Arnd Bergmann43a99072009-02-10 00:00:22 +01001073#define SEQ_LOAD_GMINSTR(dev, instr)
1074#define SEQ_LOAD_GMDRUM(dev, drum)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075
Arnd Bergmann43a99072009-02-10 00:00:22 +01001076#define _SEQ_EXTERN extern
1077#define SEQ_USE_EXTBUF() \
1078 _SEQ_EXTERN unsigned char _seqbuf[]; \
1079 _SEQ_EXTERN int _seqbuflen; _SEQ_EXTERN int _seqbufptr
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080
1081#ifndef USE_SIMPLE_MACROS
1082/* Sample seqbuf_dump() implementation:
1083 *
1084 * SEQ_DEFINEBUF (2048); -- Defines a buffer for 2048 bytes
1085 *
1086 * int seqfd; -- The file descriptor for /dev/sequencer.
1087 *
1088 * void
1089 * seqbuf_dump ()
1090 * {
1091 * if (_seqbufptr)
1092 * if (write (seqfd, _seqbuf, _seqbufptr) == -1)
1093 * {
1094 * perror ("write /dev/sequencer");
1095 * exit (-1);
1096 * }
1097 * _seqbufptr = 0;
1098 * }
1099 */
1100
1101#define SEQ_DEFINEBUF(len) unsigned char _seqbuf[len]; int _seqbuflen = len;int _seqbufptr = 0
1102#define _SEQ_NEEDBUF(len) if ((_seqbufptr+(len)) > _seqbuflen) seqbuf_dump()
1103#define _SEQ_ADVBUF(len) _seqbufptr += len
1104#define SEQ_DUMPBUF seqbuf_dump
1105#else
1106/*
1107 * This variation of the sequencer macros is used just to format one event
1108 * using fixed buffer.
1109 *
1110 * The program using the macro library must define the following macros before
1111 * using this library.
1112 *
1113 * #define _seqbuf name of the buffer (unsigned char[])
1114 * #define _SEQ_ADVBUF(len) If the applic needs to know the exact
1115 * size of the event, this macro can be used.
1116 * Otherwise this must be defined as empty.
1117 * #define _seqbufptr Define the name of index variable or 0 if
1118 * not required.
1119 */
1120#define _SEQ_NEEDBUF(len) /* empty */
1121#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122
1123#define SEQ_VOLUME_MODE(dev, mode) {_SEQ_NEEDBUF(8);\
1124 _seqbuf[_seqbufptr] = SEQ_EXTENDED;\
1125 _seqbuf[_seqbufptr+1] = SEQ_VOLMODE;\
1126 _seqbuf[_seqbufptr+2] = (dev);\
1127 _seqbuf[_seqbufptr+3] = (mode);\
1128 _seqbuf[_seqbufptr+4] = 0;\
1129 _seqbuf[_seqbufptr+5] = 0;\
1130 _seqbuf[_seqbufptr+6] = 0;\
1131 _seqbuf[_seqbufptr+7] = 0;\
1132 _SEQ_ADVBUF(8);}
1133
1134/*
1135 * Midi voice messages
1136 */
1137
1138#define _CHN_VOICE(dev, event, chn, note, parm) \
1139 {_SEQ_NEEDBUF(8);\
1140 _seqbuf[_seqbufptr] = EV_CHN_VOICE;\
1141 _seqbuf[_seqbufptr+1] = (dev);\
1142 _seqbuf[_seqbufptr+2] = (event);\
1143 _seqbuf[_seqbufptr+3] = (chn);\
1144 _seqbuf[_seqbufptr+4] = (note);\
1145 _seqbuf[_seqbufptr+5] = (parm);\
1146 _seqbuf[_seqbufptr+6] = (0);\
1147 _seqbuf[_seqbufptr+7] = 0;\
1148 _SEQ_ADVBUF(8);}
1149
1150#define SEQ_START_NOTE(dev, chn, note, vol) \
1151 _CHN_VOICE(dev, MIDI_NOTEON, chn, note, vol)
1152
1153#define SEQ_STOP_NOTE(dev, chn, note, vol) \
1154 _CHN_VOICE(dev, MIDI_NOTEOFF, chn, note, vol)
1155
1156#define SEQ_KEY_PRESSURE(dev, chn, note, pressure) \
1157 _CHN_VOICE(dev, MIDI_KEY_PRESSURE, chn, note, pressure)
1158
1159/*
1160 * Midi channel messages
1161 */
1162
1163#define _CHN_COMMON(dev, event, chn, p1, p2, w14) \
1164 {_SEQ_NEEDBUF(8);\
1165 _seqbuf[_seqbufptr] = EV_CHN_COMMON;\
1166 _seqbuf[_seqbufptr+1] = (dev);\
1167 _seqbuf[_seqbufptr+2] = (event);\
1168 _seqbuf[_seqbufptr+3] = (chn);\
1169 _seqbuf[_seqbufptr+4] = (p1);\
1170 _seqbuf[_seqbufptr+5] = (p2);\
1171 *(short *)&_seqbuf[_seqbufptr+6] = (w14);\
1172 _SEQ_ADVBUF(8);}
1173/*
1174 * SEQ_SYSEX permits sending of sysex messages. (It may look that it permits
1175 * sending any MIDI bytes but it's absolutely not possible. Trying to do
1176 * so _will_ cause problems with MPU401 intelligent mode).
1177 *
1178 * Sysex messages are sent in blocks of 1 to 6 bytes. Longer messages must be
1179 * sent by calling SEQ_SYSEX() several times (there must be no other events
1180 * between them). First sysex fragment must have 0xf0 in the first byte
1181 * and the last byte (buf[len-1] of the last fragment must be 0xf7. No byte
1182 * between these sysex start and end markers cannot be larger than 0x7f. Also
1183 * lengths of each fragments (except the last one) must be 6.
1184 *
1185 * Breaking the above rules may work with some MIDI ports but is likely to
1186 * cause fatal problems with some other devices (such as MPU401).
1187 */
1188#define SEQ_SYSEX(dev, buf, len) \
1189 {int ii, ll=(len); \
1190 unsigned char *bufp=buf;\
1191 if (ll>6)ll=6;\
1192 _SEQ_NEEDBUF(8);\
1193 _seqbuf[_seqbufptr] = EV_SYSEX;\
1194 _seqbuf[_seqbufptr+1] = (dev);\
1195 for(ii=0;ii<ll;ii++)\
1196 _seqbuf[_seqbufptr+ii+2] = bufp[ii];\
1197 for(ii=ll;ii<6;ii++)\
1198 _seqbuf[_seqbufptr+ii+2] = 0xff;\
1199 _SEQ_ADVBUF(8);}
1200
1201#define SEQ_CHN_PRESSURE(dev, chn, pressure) \
1202 _CHN_COMMON(dev, MIDI_CHN_PRESSURE, chn, pressure, 0, 0)
1203
1204#define SEQ_SET_PATCH SEQ_PGM_CHANGE
Arnd Bergmann43a99072009-02-10 00:00:22 +01001205#define SEQ_PGM_CHANGE(dev, chn, patch) \
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 _CHN_COMMON(dev, MIDI_PGM_CHANGE, chn, patch, 0, 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207
1208#define SEQ_CONTROL(dev, chn, controller, value) \
1209 _CHN_COMMON(dev, MIDI_CTL_CHANGE, chn, controller, 0, value)
1210
1211#define SEQ_BENDER(dev, chn, value) \
1212 _CHN_COMMON(dev, MIDI_PITCH_BEND, chn, 0, 0, value)
1213
1214
1215#define SEQ_V2_X_CONTROL(dev, voice, controller, value) {_SEQ_NEEDBUF(8);\
1216 _seqbuf[_seqbufptr] = SEQ_EXTENDED;\
1217 _seqbuf[_seqbufptr+1] = SEQ_CONTROLLER;\
1218 _seqbuf[_seqbufptr+2] = (dev);\
1219 _seqbuf[_seqbufptr+3] = (voice);\
1220 _seqbuf[_seqbufptr+4] = (controller);\
1221 _seqbuf[_seqbufptr+5] = ((value)&0xff);\
1222 _seqbuf[_seqbufptr+6] = ((value>>8)&0xff);\
1223 _seqbuf[_seqbufptr+7] = 0;\
1224 _SEQ_ADVBUF(8);}
1225/*
1226 * The following 5 macros are incorrectly implemented and obsolete.
1227 * Use SEQ_BENDER and SEQ_CONTROL (with proper controller) instead.
1228 */
1229#define SEQ_PITCHBEND(dev, voice, value) SEQ_V2_X_CONTROL(dev, voice, CTRL_PITCH_BENDER, value)
1230#define SEQ_BENDER_RANGE(dev, voice, value) SEQ_V2_X_CONTROL(dev, voice, CTRL_PITCH_BENDER_RANGE, value)
1231#define SEQ_EXPRESSION(dev, voice, value) SEQ_CONTROL(dev, voice, CTL_EXPRESSION, value*128)
1232#define SEQ_MAIN_VOLUME(dev, voice, value) SEQ_CONTROL(dev, voice, CTL_MAIN_VOLUME, (value*16383)/100)
1233#define SEQ_PANNING(dev, voice, pos) SEQ_CONTROL(dev, voice, CTL_PAN, (pos+128) / 2)
1234
1235/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001236 * Timing and synchronization macros
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 */
1238
1239#define _TIMER_EVENT(ev, parm) {_SEQ_NEEDBUF(8);\
1240 _seqbuf[_seqbufptr+0] = EV_TIMING; \
1241 _seqbuf[_seqbufptr+1] = (ev); \
1242 _seqbuf[_seqbufptr+2] = 0;\
1243 _seqbuf[_seqbufptr+3] = 0;\
1244 *(unsigned int *)&_seqbuf[_seqbufptr+4] = (parm); \
1245 _SEQ_ADVBUF(8);}
1246
1247#define SEQ_START_TIMER() _TIMER_EVENT(TMR_START, 0)
1248#define SEQ_STOP_TIMER() _TIMER_EVENT(TMR_STOP, 0)
1249#define SEQ_CONTINUE_TIMER() _TIMER_EVENT(TMR_CONTINUE, 0)
1250#define SEQ_WAIT_TIME(ticks) _TIMER_EVENT(TMR_WAIT_ABS, ticks)
1251#define SEQ_DELTA_TIME(ticks) _TIMER_EVENT(TMR_WAIT_REL, ticks)
1252#define SEQ_ECHO_BACK(key) _TIMER_EVENT(TMR_ECHO, key)
1253#define SEQ_SET_TEMPO(value) _TIMER_EVENT(TMR_TEMPO, value)
1254#define SEQ_SONGPOS(pos) _TIMER_EVENT(TMR_SPP, pos)
1255#define SEQ_TIME_SIGNATURE(sig) _TIMER_EVENT(TMR_TIMESIG, sig)
1256
1257/*
1258 * Local control events
1259 */
1260
1261#define _LOCAL_EVENT(ev, parm) {_SEQ_NEEDBUF(8);\
1262 _seqbuf[_seqbufptr+0] = EV_SEQ_LOCAL; \
1263 _seqbuf[_seqbufptr+1] = (ev); \
1264 _seqbuf[_seqbufptr+2] = 0;\
1265 _seqbuf[_seqbufptr+3] = 0;\
1266 *(unsigned int *)&_seqbuf[_seqbufptr+4] = (parm); \
1267 _SEQ_ADVBUF(8);}
1268
1269#define SEQ_PLAYAUDIO(devmask) _LOCAL_EVENT(LOCL_STARTAUDIO, devmask)
1270/*
1271 * Events for the level 1 interface only
1272 */
1273
1274#define SEQ_MIDIOUT(device, byte) {_SEQ_NEEDBUF(4);\
1275 _seqbuf[_seqbufptr] = SEQ_MIDIPUTC;\
1276 _seqbuf[_seqbufptr+1] = (byte);\
1277 _seqbuf[_seqbufptr+2] = (device);\
1278 _seqbuf[_seqbufptr+3] = 0;\
1279 _SEQ_ADVBUF(4);}
1280
1281/*
1282 * Patch loading.
1283 */
Arnd Bergmann43a99072009-02-10 00:00:22 +01001284#define SEQ_WRPATCH(patchx, len) \
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 {if (_seqbufptr) SEQ_DUMPBUF();\
1286 if (write(seqfd, (char*)(patchx), len)==-1) \
1287 perror("Write patch: /dev/sequencer");}
Arnd Bergmann43a99072009-02-10 00:00:22 +01001288#define SEQ_WRPATCH2(patchx, len) \
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 (SEQ_DUMPBUF(), write(seqfd, (char*)(patchx), len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290
1291#endif
1292#endif