2 * Advanced Linux Sound Architecture - ALSA - Driver
3 * Copyright (c) 1994-2003 by Jaroslav Kysela <perex@suse.cz>,
4 * Abramo Bagnara <abramo@alsa-project.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #ifndef __SOUND_ASOUND_H
24 #define __SOUND_ASOUND_H
26 #if defined(LINUX) || defined(__LINUX__) || defined(__linux__)
28 #include <linux/ioctl.h>
32 #include <linux/types.h>
33 #include <linux/time.h>
34 #include <asm/byteorder.h>
36 #if __LITTLE_ENDIAN == 1234
37 #define SNDRV_LITTLE_ENDIAN
38 #elif __BIG_ENDIAN == 4321
39 #define SNDRV_BIG_ENDIAN
41 #error "Unsupported endian..."
44 #else /* !__KERNEL__ */
47 #if __BYTE_ORDER == __LITTLE_ENDIAN
48 #define SNDRV_LITTLE_ENDIAN
49 #elif __BYTE_ORDER == __BIG_ENDIAN
50 #define SNDRV_BIG_ENDIAN
52 #error "Unsupported endian..."
55 #endif /* __KERNEL **/
61 #include <sys/types.h>
68 #define SNDRV_PROTOCOL_VERSION(major, minor, subminor) (((major)<<16)|((minor)<<8)|(subminor))
69 #define SNDRV_PROTOCOL_MAJOR(version) (((version)>>16)&0xffff)
70 #define SNDRV_PROTOCOL_MINOR(version) (((version)>>8)&0xff)
71 #define SNDRV_PROTOCOL_MICRO(version) ((version)&0xff)
72 #define SNDRV_PROTOCOL_INCOMPATIBLE(kversion, uversion) \
73 (SNDRV_PROTOCOL_MAJOR(kversion) != SNDRV_PROTOCOL_MAJOR(uversion) || \
74 (SNDRV_PROTOCOL_MAJOR(kversion) == SNDRV_PROTOCOL_MAJOR(uversion) && \
75 SNDRV_PROTOCOL_MINOR(kversion) != SNDRV_PROTOCOL_MINOR(uversion)))
77 /****************************************************************************
79 * Digital audio interface *
81 ****************************************************************************/
83 struct sndrv_aes_iec958 {
84 unsigned char status[24]; /* AES/IEC958 channel status bits */
85 unsigned char subcode[147]; /* AES/IEC958 subcode bits */
86 unsigned char pad; /* nothing */
87 unsigned char dig_subframe[4]; /* AES/IEC958 subframe bits */
90 /****************************************************************************
92 * Section for driver hardware dependent interface - /dev/snd/hw? *
94 ****************************************************************************/
96 #define SNDRV_HWDEP_VERSION SNDRV_PROTOCOL_VERSION(1, 0, 1)
98 enum sndrv_hwdep_iface {
99 SNDRV_HWDEP_IFACE_OPL2 = 0,
100 SNDRV_HWDEP_IFACE_OPL3,
101 SNDRV_HWDEP_IFACE_OPL4,
102 SNDRV_HWDEP_IFACE_SB16CSP, /* Creative Signal Processor */
103 SNDRV_HWDEP_IFACE_EMU10K1, /* FX8010 processor in EMU10K1 chip */
104 SNDRV_HWDEP_IFACE_YSS225, /* Yamaha FX processor */
105 SNDRV_HWDEP_IFACE_ICS2115, /* Wavetable synth */
106 SNDRV_HWDEP_IFACE_SSCAPE, /* Ensoniq SoundScape ISA card (MC68EC000) */
107 SNDRV_HWDEP_IFACE_VX, /* Digigram VX cards */
108 SNDRV_HWDEP_IFACE_MIXART, /* Digigram miXart cards */
109 SNDRV_HWDEP_IFACE_USX2Y, /* Tascam US122, US224 & US428 usb */
110 SNDRV_HWDEP_IFACE_EMUX_WAVETABLE, /* EmuX wavetable */
112 /* Don't forget to change the following: */
113 SNDRV_HWDEP_IFACE_LAST = SNDRV_HWDEP_IFACE_EMUX_WAVETABLE,
116 struct sndrv_hwdep_info {
117 unsigned int device; /* WR: device number */
118 int card; /* R: card number */
119 unsigned char id[64]; /* ID (user selectable) */
120 unsigned char name[80]; /* hwdep name */
121 enum sndrv_hwdep_iface iface; /* hwdep interface */
122 unsigned char reserved[64]; /* reserved for future */
125 /* generic DSP loader */
126 struct sndrv_hwdep_dsp_status {
127 unsigned int version; /* R: driver-specific version */
128 unsigned char id[32]; /* R: driver-specific ID string */
129 unsigned int num_dsps; /* R: number of DSP images to transfer */
130 unsigned int dsp_loaded; /* R: bit flags indicating the loaded DSPs */
131 unsigned int chip_ready; /* R: 1 = initialization finished */
132 unsigned char reserved[16]; /* reserved for future use */
135 struct sndrv_hwdep_dsp_image {
136 unsigned int index; /* W: DSP index */
137 unsigned char name[64]; /* W: ID (e.g. file name) */
138 unsigned char *image; /* W: binary image */
139 size_t length; /* W: size of image in bytes */
140 unsigned long driver_data; /* W: driver-specific data */
144 SNDRV_HWDEP_IOCTL_PVERSION = _IOR ('H', 0x00, int),
145 SNDRV_HWDEP_IOCTL_INFO = _IOR ('H', 0x01, struct sndrv_hwdep_info),
146 SNDRV_HWDEP_IOCTL_DSP_STATUS = _IOR('H', 0x02, struct sndrv_hwdep_dsp_status),
147 SNDRV_HWDEP_IOCTL_DSP_LOAD = _IOW('H', 0x03, struct sndrv_hwdep_dsp_image)
150 /*****************************************************************************
152 * Digital Audio (PCM) interface - /dev/snd/pcm?? *
154 *****************************************************************************/
156 #define SNDRV_PCM_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 6)
158 typedef unsigned long sndrv_pcm_uframes_t;
159 typedef long sndrv_pcm_sframes_t;
161 enum sndrv_pcm_class {
162 SNDRV_PCM_CLASS_GENERIC = 0, /* standard mono or stereo device */
163 SNDRV_PCM_CLASS_MULTI, /* multichannel device */
164 SNDRV_PCM_CLASS_MODEM, /* software modem class */
165 SNDRV_PCM_CLASS_DIGITIZER, /* digitizer class */
166 /* Don't forget to change the following: */
167 SNDRV_PCM_CLASS_LAST = SNDRV_PCM_CLASS_DIGITIZER,
170 enum sndrv_pcm_subclass {
171 SNDRV_PCM_SUBCLASS_GENERIC_MIX = 0, /* mono or stereo subdevices are mixed together */
172 SNDRV_PCM_SUBCLASS_MULTI_MIX, /* multichannel subdevices are mixed together */
173 /* Don't forget to change the following: */
174 SNDRV_PCM_SUBCLASS_LAST = SNDRV_PCM_SUBCLASS_MULTI_MIX,
177 enum sndrv_pcm_stream {
178 SNDRV_PCM_STREAM_PLAYBACK = 0,
179 SNDRV_PCM_STREAM_CAPTURE,
180 SNDRV_PCM_STREAM_LAST = SNDRV_PCM_STREAM_CAPTURE,
183 enum sndrv_pcm_access {
184 SNDRV_PCM_ACCESS_MMAP_INTERLEAVED = 0, /* interleaved mmap */
185 SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED, /* noninterleaved mmap */
186 SNDRV_PCM_ACCESS_MMAP_COMPLEX, /* complex mmap */
187 SNDRV_PCM_ACCESS_RW_INTERLEAVED, /* readi/writei */
188 SNDRV_PCM_ACCESS_RW_NONINTERLEAVED, /* readn/writen */
189 SNDRV_PCM_ACCESS_LAST = SNDRV_PCM_ACCESS_RW_NONINTERLEAVED,
192 enum sndrv_pcm_format {
193 SNDRV_PCM_FORMAT_S8 = 0,
195 SNDRV_PCM_FORMAT_S16_LE,
196 SNDRV_PCM_FORMAT_S16_BE,
197 SNDRV_PCM_FORMAT_U16_LE,
198 SNDRV_PCM_FORMAT_U16_BE,
199 SNDRV_PCM_FORMAT_S24_LE, /* low three bytes */
200 SNDRV_PCM_FORMAT_S24_BE, /* low three bytes */
201 SNDRV_PCM_FORMAT_U24_LE, /* low three bytes */
202 SNDRV_PCM_FORMAT_U24_BE, /* low three bytes */
203 SNDRV_PCM_FORMAT_S32_LE,
204 SNDRV_PCM_FORMAT_S32_BE,
205 SNDRV_PCM_FORMAT_U32_LE,
206 SNDRV_PCM_FORMAT_U32_BE,
207 SNDRV_PCM_FORMAT_FLOAT_LE, /* 4-byte float, IEEE-754 32-bit, range -1.0 to 1.0 */
208 SNDRV_PCM_FORMAT_FLOAT_BE, /* 4-byte float, IEEE-754 32-bit, range -1.0 to 1.0 */
209 SNDRV_PCM_FORMAT_FLOAT64_LE, /* 8-byte float, IEEE-754 64-bit, range -1.0 to 1.0 */
210 SNDRV_PCM_FORMAT_FLOAT64_BE, /* 8-byte float, IEEE-754 64-bit, range -1.0 to 1.0 */
211 SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE, /* IEC-958 subframe, Little Endian */
212 SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE, /* IEC-958 subframe, Big Endian */
213 SNDRV_PCM_FORMAT_MU_LAW,
214 SNDRV_PCM_FORMAT_A_LAW,
215 SNDRV_PCM_FORMAT_IMA_ADPCM,
216 SNDRV_PCM_FORMAT_MPEG,
217 SNDRV_PCM_FORMAT_GSM,
218 SNDRV_PCM_FORMAT_SPECIAL = 31,
219 SNDRV_PCM_FORMAT_S24_3LE = 32, /* in three bytes */
220 SNDRV_PCM_FORMAT_S24_3BE, /* in three bytes */
221 SNDRV_PCM_FORMAT_U24_3LE, /* in three bytes */
222 SNDRV_PCM_FORMAT_U24_3BE, /* in three bytes */
223 SNDRV_PCM_FORMAT_S20_3LE, /* in three bytes */
224 SNDRV_PCM_FORMAT_S20_3BE, /* in three bytes */
225 SNDRV_PCM_FORMAT_U20_3LE, /* in three bytes */
226 SNDRV_PCM_FORMAT_U20_3BE, /* in three bytes */
227 SNDRV_PCM_FORMAT_S18_3LE, /* in three bytes */
228 SNDRV_PCM_FORMAT_S18_3BE, /* in three bytes */
229 SNDRV_PCM_FORMAT_U18_3LE, /* in three bytes */
230 SNDRV_PCM_FORMAT_U18_3BE, /* in three bytes */
231 SNDRV_PCM_FORMAT_LAST = SNDRV_PCM_FORMAT_U18_3BE,
233 #ifdef SNDRV_LITTLE_ENDIAN
234 SNDRV_PCM_FORMAT_S16 = SNDRV_PCM_FORMAT_S16_LE,
235 SNDRV_PCM_FORMAT_U16 = SNDRV_PCM_FORMAT_U16_LE,
236 SNDRV_PCM_FORMAT_S24 = SNDRV_PCM_FORMAT_S24_LE,
237 SNDRV_PCM_FORMAT_U24 = SNDRV_PCM_FORMAT_U24_LE,
238 SNDRV_PCM_FORMAT_S32 = SNDRV_PCM_FORMAT_S32_LE,
239 SNDRV_PCM_FORMAT_U32 = SNDRV_PCM_FORMAT_U32_LE,
240 SNDRV_PCM_FORMAT_FLOAT = SNDRV_PCM_FORMAT_FLOAT_LE,
241 SNDRV_PCM_FORMAT_FLOAT64 = SNDRV_PCM_FORMAT_FLOAT64_LE,
242 SNDRV_PCM_FORMAT_IEC958_SUBFRAME = SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE,
244 #ifdef SNDRV_BIG_ENDIAN
245 SNDRV_PCM_FORMAT_S16 = SNDRV_PCM_FORMAT_S16_BE,
246 SNDRV_PCM_FORMAT_U16 = SNDRV_PCM_FORMAT_U16_BE,
247 SNDRV_PCM_FORMAT_S24 = SNDRV_PCM_FORMAT_S24_BE,
248 SNDRV_PCM_FORMAT_U24 = SNDRV_PCM_FORMAT_U24_BE,
249 SNDRV_PCM_FORMAT_S32 = SNDRV_PCM_FORMAT_S32_BE,
250 SNDRV_PCM_FORMAT_U32 = SNDRV_PCM_FORMAT_U32_BE,
251 SNDRV_PCM_FORMAT_FLOAT = SNDRV_PCM_FORMAT_FLOAT_BE,
252 SNDRV_PCM_FORMAT_FLOAT64 = SNDRV_PCM_FORMAT_FLOAT64_BE,
253 SNDRV_PCM_FORMAT_IEC958_SUBFRAME = SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE,
257 enum sndrv_pcm_subformat {
258 SNDRV_PCM_SUBFORMAT_STD = 0,
259 SNDRV_PCM_SUBFORMAT_LAST = SNDRV_PCM_SUBFORMAT_STD,
262 #define SNDRV_PCM_INFO_MMAP 0x00000001 /* hardware supports mmap */
263 #define SNDRV_PCM_INFO_MMAP_VALID 0x00000002 /* period data are valid during transfer */
264 #define SNDRV_PCM_INFO_DOUBLE 0x00000004 /* Double buffering needed for PCM start/stop */
265 #define SNDRV_PCM_INFO_BATCH 0x00000010 /* double buffering */
266 #define SNDRV_PCM_INFO_INTERLEAVED 0x00000100 /* channels are interleaved */
267 #define SNDRV_PCM_INFO_NONINTERLEAVED 0x00000200 /* channels are not interleaved */
268 #define SNDRV_PCM_INFO_COMPLEX 0x00000400 /* complex frame organization (mmap only) */
269 #define SNDRV_PCM_INFO_BLOCK_TRANSFER 0x00010000 /* hardware transfer block of samples */
270 #define SNDRV_PCM_INFO_OVERRANGE 0x00020000 /* hardware supports ADC (capture) overrange detection */
271 #define SNDRV_PCM_INFO_RESUME 0x00040000 /* hardware supports stream resume after suspend */
272 #define SNDRV_PCM_INFO_PAUSE 0x00080000 /* pause ioctl is supported */
273 #define SNDRV_PCM_INFO_HALF_DUPLEX 0x00100000 /* only half duplex */
274 #define SNDRV_PCM_INFO_JOINT_DUPLEX 0x00200000 /* playback and capture stream are somewhat correlated */
275 #define SNDRV_PCM_INFO_SYNC_START 0x00400000 /* pcm support some kind of sync go */
276 #define SNDRV_PCM_INFO_NONATOMIC_OPS 0x00800000 /* non-atomic prepare callback */
278 enum sndrv_pcm_state {
279 SNDRV_PCM_STATE_OPEN = 0, /* stream is open */
280 SNDRV_PCM_STATE_SETUP, /* stream has a setup */
281 SNDRV_PCM_STATE_PREPARED, /* stream is ready to start */
282 SNDRV_PCM_STATE_RUNNING, /* stream is running */
283 SNDRV_PCM_STATE_XRUN, /* stream reached an xrun */
284 SNDRV_PCM_STATE_DRAINING, /* stream is draining */
285 SNDRV_PCM_STATE_PAUSED, /* stream is paused */
286 SNDRV_PCM_STATE_SUSPENDED, /* hardware is suspended */
287 SNDRV_PCM_STATE_DISCONNECTED, /* hardware is disconnected */
288 SNDRV_PCM_STATE_LAST = SNDRV_PCM_STATE_DISCONNECTED,
292 SNDRV_PCM_MMAP_OFFSET_DATA = 0x00000000,
293 SNDRV_PCM_MMAP_OFFSET_STATUS = 0x80000000,
294 SNDRV_PCM_MMAP_OFFSET_CONTROL = 0x81000000,
297 union sndrv_pcm_sync_id {
298 unsigned char id[16];
299 unsigned short id16[8];
300 unsigned int id32[4];
303 struct sndrv_pcm_info {
304 unsigned int device; /* RO/WR (control): device number */
305 unsigned int subdevice; /* RO/WR (control): subdevice number */
306 enum sndrv_pcm_stream stream; /* RO/WR (control): stream number */
307 int card; /* R: card number */
308 unsigned char id[64]; /* ID (user selectable) */
309 unsigned char name[80]; /* name of this device */
310 unsigned char subname[32]; /* subdevice name */
311 enum sndrv_pcm_class dev_class; /* SNDRV_PCM_CLASS_* */
312 enum sndrv_pcm_subclass dev_subclass; /* SNDRV_PCM_SUBCLASS_* */
313 unsigned int subdevices_count;
314 unsigned int subdevices_avail;
315 union sndrv_pcm_sync_id sync; /* hardware synchronization ID */
316 unsigned char reserved[64]; /* reserved for future... */
319 enum sndrv_pcm_hw_param {
320 SNDRV_PCM_HW_PARAM_ACCESS = 0, /* Access type */
321 SNDRV_PCM_HW_PARAM_FIRST_MASK = SNDRV_PCM_HW_PARAM_ACCESS,
322 SNDRV_PCM_HW_PARAM_FORMAT, /* Format */
323 SNDRV_PCM_HW_PARAM_SUBFORMAT, /* Subformat */
324 SNDRV_PCM_HW_PARAM_LAST_MASK = SNDRV_PCM_HW_PARAM_SUBFORMAT,
326 SNDRV_PCM_HW_PARAM_SAMPLE_BITS = 8, /* Bits per sample */
327 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL = SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
328 SNDRV_PCM_HW_PARAM_FRAME_BITS, /* Bits per frame */
329 SNDRV_PCM_HW_PARAM_CHANNELS, /* Channels */
330 SNDRV_PCM_HW_PARAM_RATE, /* Approx rate */
331 SNDRV_PCM_HW_PARAM_PERIOD_TIME, /* Approx distance between interrupts
333 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, /* Approx frames between interrupts */
334 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, /* Approx bytes between interrupts */
335 SNDRV_PCM_HW_PARAM_PERIODS, /* Approx interrupts per buffer */
336 SNDRV_PCM_HW_PARAM_BUFFER_TIME, /* Approx duration of buffer in us */
337 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, /* Size of buffer in frames */
338 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, /* Size of buffer in bytes */
339 SNDRV_PCM_HW_PARAM_TICK_TIME, /* Approx tick duration in us */
340 SNDRV_PCM_HW_PARAM_LAST_INTERVAL = SNDRV_PCM_HW_PARAM_TICK_TIME
343 #define SNDRV_PCM_HW_PARAMS_RUNTIME (1<<0)
345 struct sndrv_interval {
346 unsigned int min, max;
347 unsigned int openmin:1,
353 #define SNDRV_MASK_MAX 256
356 u_int32_t bits[(SNDRV_MASK_MAX+31)/32];
359 struct sndrv_pcm_hw_params {
361 struct sndrv_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
362 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
363 struct sndrv_mask mres[5]; /* reserved masks */
364 struct sndrv_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
365 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
366 struct sndrv_interval ires[9]; /* reserved intervals */
367 unsigned int rmask; /* W: requested masks */
368 unsigned int cmask; /* R: changed masks */
369 unsigned int info; /* R: Info flags for returned setup */
370 unsigned int msbits; /* R: used most significant bits */
371 unsigned int rate_num; /* R: rate numerator */
372 unsigned int rate_den; /* R: rate denominator */
373 sndrv_pcm_uframes_t fifo_size; /* R: chip FIFO size in frames */
374 unsigned char reserved[64]; /* reserved for future */
377 enum sndrv_pcm_tstamp {
378 SNDRV_PCM_TSTAMP_NONE = 0,
379 SNDRV_PCM_TSTAMP_MMAP,
380 SNDRV_PCM_TSTAMP_LAST = SNDRV_PCM_TSTAMP_MMAP,
383 struct sndrv_pcm_sw_params {
384 enum sndrv_pcm_tstamp tstamp_mode; /* timestamp mode */
385 unsigned int period_step;
386 unsigned int sleep_min; /* min ticks to sleep */
387 sndrv_pcm_uframes_t avail_min; /* min avail frames for wakeup */
388 sndrv_pcm_uframes_t xfer_align; /* xfer size need to be a multiple */
389 sndrv_pcm_uframes_t start_threshold; /* min hw_avail frames for automatic start */
390 sndrv_pcm_uframes_t stop_threshold; /* min avail frames for automatic stop */
391 sndrv_pcm_uframes_t silence_threshold; /* min distance from noise for silence filling */
392 sndrv_pcm_uframes_t silence_size; /* silence block size */
393 sndrv_pcm_uframes_t boundary; /* pointers wrap point */
394 unsigned char reserved[64]; /* reserved for future */
397 struct sndrv_pcm_channel_info {
398 unsigned int channel;
399 off_t offset; /* mmap offset */
400 unsigned int first; /* offset to first sample in bits */
401 unsigned int step; /* samples distance in bits */
404 struct sndrv_pcm_status {
405 enum sndrv_pcm_state state; /* stream state */
406 struct timespec trigger_tstamp; /* time when stream was started/stopped/paused */
407 struct timespec tstamp; /* reference timestamp */
408 sndrv_pcm_uframes_t appl_ptr; /* appl ptr */
409 sndrv_pcm_uframes_t hw_ptr; /* hw ptr */
410 sndrv_pcm_sframes_t delay; /* current delay in frames */
411 sndrv_pcm_uframes_t avail; /* number of frames available */
412 sndrv_pcm_uframes_t avail_max; /* max frames available on hw since last status */
413 sndrv_pcm_uframes_t overrange; /* count of ADC (capture) overrange detections from last status */
414 enum sndrv_pcm_state suspended_state; /* suspended stream state */
415 unsigned char reserved[60]; /* must be filled with zero */
418 struct sndrv_pcm_mmap_status {
419 enum sndrv_pcm_state state; /* RO: state - SNDRV_PCM_STATE_XXXX */
420 int pad1; /* Needed for 64 bit alignment */
421 sndrv_pcm_uframes_t hw_ptr; /* RO: hw ptr (0...boundary-1) */
422 struct timespec tstamp; /* Timestamp */
423 enum sndrv_pcm_state suspended_state; /* RO: suspended stream state */
426 struct sndrv_pcm_mmap_control {
427 sndrv_pcm_uframes_t appl_ptr; /* RW: appl ptr (0...boundary-1) */
428 sndrv_pcm_uframes_t avail_min; /* RW: min available frames for wakeup */
432 sndrv_pcm_sframes_t result;
434 sndrv_pcm_uframes_t frames;
438 sndrv_pcm_sframes_t result;
440 sndrv_pcm_uframes_t frames;
444 SNDRV_PCM_IOCTL_PVERSION = _IOR('A', 0x00, int),
445 SNDRV_PCM_IOCTL_INFO = _IOR('A', 0x01, struct sndrv_pcm_info),
446 SNDRV_PCM_IOCTL_TSTAMP = _IOW('A', 0x02, int),
447 SNDRV_PCM_IOCTL_HW_REFINE = _IOWR('A', 0x10, struct sndrv_pcm_hw_params),
448 SNDRV_PCM_IOCTL_HW_PARAMS = _IOWR('A', 0x11, struct sndrv_pcm_hw_params),
449 SNDRV_PCM_IOCTL_HW_FREE = _IO('A', 0x12),
450 SNDRV_PCM_IOCTL_SW_PARAMS = _IOWR('A', 0x13, struct sndrv_pcm_sw_params),
451 SNDRV_PCM_IOCTL_STATUS = _IOR('A', 0x20, struct sndrv_pcm_status),
452 SNDRV_PCM_IOCTL_DELAY = _IOR('A', 0x21, sndrv_pcm_sframes_t),
453 SNDRV_PCM_IOCTL_HWSYNC = _IO('A', 0x22),
454 SNDRV_PCM_IOCTL_CHANNEL_INFO = _IOR('A', 0x32, struct sndrv_pcm_channel_info),
455 SNDRV_PCM_IOCTL_PREPARE = _IO('A', 0x40),
456 SNDRV_PCM_IOCTL_RESET = _IO('A', 0x41),
457 SNDRV_PCM_IOCTL_START = _IO('A', 0x42),
458 SNDRV_PCM_IOCTL_DROP = _IO('A', 0x43),
459 SNDRV_PCM_IOCTL_DRAIN = _IO('A', 0x44),
460 SNDRV_PCM_IOCTL_PAUSE = _IOW('A', 0x45, int),
461 SNDRV_PCM_IOCTL_REWIND = _IOW('A', 0x46, sndrv_pcm_uframes_t),
462 SNDRV_PCM_IOCTL_RESUME = _IO('A', 0x47),
463 SNDRV_PCM_IOCTL_XRUN = _IO('A', 0x48),
464 SNDRV_PCM_IOCTL_FORWARD = _IOW('A', 0x49, sndrv_pcm_uframes_t),
465 SNDRV_PCM_IOCTL_WRITEI_FRAMES = _IOW('A', 0x50, struct sndrv_xferi),
466 SNDRV_PCM_IOCTL_READI_FRAMES = _IOR('A', 0x51, struct sndrv_xferi),
467 SNDRV_PCM_IOCTL_WRITEN_FRAMES = _IOW('A', 0x52, struct sndrv_xfern),
468 SNDRV_PCM_IOCTL_READN_FRAMES = _IOR('A', 0x53, struct sndrv_xfern),
469 SNDRV_PCM_IOCTL_LINK = _IOW('A', 0x60, int),
470 SNDRV_PCM_IOCTL_UNLINK = _IO('A', 0x61),
473 /* Trick to make alsa-lib/acinclude.m4 happy */
474 #define SNDRV_PCM_IOCTL_REWIND SNDRV_PCM_IOCTL_REWIND
476 /*****************************************************************************
478 * MIDI v1.0 interface *
480 *****************************************************************************/
483 * Raw MIDI section - /dev/snd/midi??
486 #define SNDRV_RAWMIDI_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 0)
488 enum sndrv_rawmidi_stream {
489 SNDRV_RAWMIDI_STREAM_OUTPUT = 0,
490 SNDRV_RAWMIDI_STREAM_INPUT,
491 SNDRV_RAWMIDI_STREAM_LAST = SNDRV_RAWMIDI_STREAM_INPUT,
494 #define SNDRV_RAWMIDI_INFO_OUTPUT 0x00000001
495 #define SNDRV_RAWMIDI_INFO_INPUT 0x00000002
496 #define SNDRV_RAWMIDI_INFO_DUPLEX 0x00000004
498 struct sndrv_rawmidi_info {
499 unsigned int device; /* RO/WR (control): device number */
500 unsigned int subdevice; /* RO/WR (control): subdevice number */
501 enum sndrv_rawmidi_stream stream; /* WR: stream */
502 int card; /* R: card number */
503 unsigned int flags; /* SNDRV_RAWMIDI_INFO_XXXX */
504 unsigned char id[64]; /* ID (user selectable) */
505 unsigned char name[80]; /* name of device */
506 unsigned char subname[32]; /* name of active or selected subdevice */
507 unsigned int subdevices_count;
508 unsigned int subdevices_avail;
509 unsigned char reserved[64]; /* reserved for future use */
512 struct sndrv_rawmidi_params {
513 enum sndrv_rawmidi_stream stream;
514 size_t buffer_size; /* queue size in bytes */
515 size_t avail_min; /* minimum avail bytes for wakeup */
516 unsigned int no_active_sensing: 1; /* do not send active sensing byte in close() */
517 unsigned char reserved[16]; /* reserved for future use */
520 struct sndrv_rawmidi_status {
521 enum sndrv_rawmidi_stream stream;
522 struct timespec tstamp; /* Timestamp */
523 size_t avail; /* available bytes */
524 size_t xruns; /* count of overruns since last status (in bytes) */
525 unsigned char reserved[16]; /* reserved for future use */
529 SNDRV_RAWMIDI_IOCTL_PVERSION = _IOR('W', 0x00, int),
530 SNDRV_RAWMIDI_IOCTL_INFO = _IOR('W', 0x01, struct sndrv_rawmidi_info),
531 SNDRV_RAWMIDI_IOCTL_PARAMS = _IOWR('W', 0x10, struct sndrv_rawmidi_params),
532 SNDRV_RAWMIDI_IOCTL_STATUS = _IOWR('W', 0x20, struct sndrv_rawmidi_status),
533 SNDRV_RAWMIDI_IOCTL_DROP = _IOW('W', 0x30, int),
534 SNDRV_RAWMIDI_IOCTL_DRAIN = _IOW('W', 0x31, int),
538 * Timer section - /dev/snd/timer
541 #define SNDRV_TIMER_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 1)
543 enum sndrv_timer_class {
544 SNDRV_TIMER_CLASS_NONE = -1,
545 SNDRV_TIMER_CLASS_SLAVE = 0,
546 SNDRV_TIMER_CLASS_GLOBAL,
547 SNDRV_TIMER_CLASS_CARD,
548 SNDRV_TIMER_CLASS_PCM,
549 SNDRV_TIMER_CLASS_LAST = SNDRV_TIMER_CLASS_PCM,
552 /* slave timer classes */
553 enum sndrv_timer_slave_class {
554 SNDRV_TIMER_SCLASS_NONE = 0,
555 SNDRV_TIMER_SCLASS_APPLICATION,
556 SNDRV_TIMER_SCLASS_SEQUENCER, /* alias */
557 SNDRV_TIMER_SCLASS_OSS_SEQUENCER, /* alias */
558 SNDRV_TIMER_SCLASS_LAST = SNDRV_TIMER_SCLASS_OSS_SEQUENCER,
561 /* global timers (device member) */
562 #define SNDRV_TIMER_GLOBAL_SYSTEM 0
563 #define SNDRV_TIMER_GLOBAL_RTC 1
566 #define SNDRV_TIMER_FLG_SLAVE (1<<0) /* cannot be controlled */
568 struct sndrv_timer_id {
569 enum sndrv_timer_class dev_class;
570 enum sndrv_timer_slave_class dev_sclass;
576 struct sndrv_timer_ginfo {
577 struct sndrv_timer_id tid; /* requested timer ID */
578 unsigned int flags; /* timer flags - SNDRV_TIMER_FLG_* */
579 int card; /* card number */
580 unsigned char id[64]; /* timer identification */
581 unsigned char name[80]; /* timer name */
582 unsigned long reserved0; /* reserved for future use */
583 unsigned long resolution; /* average period resolution in ns */
584 unsigned long resolution_min; /* minimal period resolution in ns */
585 unsigned long resolution_max; /* maximal period resolution in ns */
586 unsigned int clients; /* active timer clients */
587 unsigned char reserved[32];
590 struct sndrv_timer_gparams {
591 struct sndrv_timer_id tid; /* requested timer ID */
592 unsigned long period_num; /* requested precise period duration (in seconds) - numerator */
593 unsigned long period_den; /* requested precise period duration (in seconds) - denominator */
594 unsigned char reserved[32];
597 struct sndrv_timer_gstatus {
598 struct sndrv_timer_id tid; /* requested timer ID */
599 unsigned long resolution; /* current period resolution in ns */
600 unsigned long resolution_num; /* precise current period resolution (in seconds) - numerator */
601 unsigned long resolution_den; /* precise current period resolution (in seconds) - denominator */
602 unsigned char reserved[32];
605 struct sndrv_timer_select {
606 struct sndrv_timer_id id; /* bind to timer ID */
607 unsigned char reserved[32]; /* reserved */
610 struct sndrv_timer_info {
611 unsigned int flags; /* timer flags - SNDRV_TIMER_FLG_* */
612 int card; /* card number */
613 unsigned char id[64]; /* timer identificator */
614 unsigned char name[80]; /* timer name */
615 unsigned long reserved0; /* reserved for future use */
616 unsigned long resolution; /* average period resolution in ns */
617 unsigned char reserved[64]; /* reserved */
620 #define SNDRV_TIMER_PSFLG_AUTO (1<<0) /* auto start, otherwise one-shot */
621 #define SNDRV_TIMER_PSFLG_EXCLUSIVE (1<<1) /* exclusive use, precise start/stop/pause/continue */
623 struct sndrv_timer_params {
624 unsigned int flags; /* flags - SNDRV_MIXER_PSFLG_* */
625 unsigned int ticks; /* requested resolution in ticks */
626 unsigned int queue_size; /* total size of queue (32-1024) */
627 unsigned int reserved0; /* reserved, was: failure locations */
628 unsigned int filter; /* event filter (bitmask of SNDRV_TIMER_EVENT_*) */
629 unsigned char reserved[60]; /* reserved */
632 struct sndrv_timer_status {
633 struct timespec tstamp; /* Timestamp - last update */
634 unsigned int resolution; /* current period resolution in ns */
635 unsigned int lost; /* counter of master tick lost */
636 unsigned int overrun; /* count of read queue overruns */
637 unsigned int queue; /* used queue size */
638 unsigned char reserved[64]; /* reserved */
642 SNDRV_TIMER_IOCTL_PVERSION = _IOR('T', 0x00, int),
643 SNDRV_TIMER_IOCTL_NEXT_DEVICE = _IOWR('T', 0x01, struct sndrv_timer_id),
644 SNDRV_TIMER_IOCTL_TREAD = _IOW('T', 0x02, int),
645 SNDRV_TIMER_IOCTL_GINFO = _IOWR('T', 0x03, struct sndrv_timer_ginfo),
646 SNDRV_TIMER_IOCTL_GPARAMS = _IOW('T', 0x04, struct sndrv_timer_gparams),
647 SNDRV_TIMER_IOCTL_GSTATUS = _IOWR('T', 0x05, struct sndrv_timer_gstatus),
648 SNDRV_TIMER_IOCTL_SELECT = _IOW('T', 0x10, struct sndrv_timer_select),
649 SNDRV_TIMER_IOCTL_INFO = _IOR('T', 0x11, struct sndrv_timer_info),
650 SNDRV_TIMER_IOCTL_PARAMS = _IOW('T', 0x12, struct sndrv_timer_params),
651 SNDRV_TIMER_IOCTL_STATUS = _IOR('T', 0x14, struct sndrv_timer_status),
652 SNDRV_TIMER_IOCTL_START = _IO('T', 0x20),
653 SNDRV_TIMER_IOCTL_STOP = _IO('T', 0x21),
654 SNDRV_TIMER_IOCTL_CONTINUE = _IO('T', 0x22),
655 SNDRV_TIMER_IOCTL_PAUSE = _IO('T', 0x23),
658 struct sndrv_timer_read {
659 unsigned int resolution;
663 enum sndrv_timer_event {
664 SNDRV_TIMER_EVENT_RESOLUTION = 0, /* val = resolution in ns */
665 SNDRV_TIMER_EVENT_TICK, /* val = ticks */
666 SNDRV_TIMER_EVENT_START, /* val = resolution in ns */
667 SNDRV_TIMER_EVENT_STOP, /* val = 0 */
668 SNDRV_TIMER_EVENT_CONTINUE, /* val = resolution in ns */
669 SNDRV_TIMER_EVENT_PAUSE, /* val = 0 */
670 /* master timer events for slave timer instances */
671 SNDRV_TIMER_EVENT_MSTART = SNDRV_TIMER_EVENT_START + 10,
672 SNDRV_TIMER_EVENT_MSTOP = SNDRV_TIMER_EVENT_STOP + 10,
673 SNDRV_TIMER_EVENT_MCONTINUE = SNDRV_TIMER_EVENT_CONTINUE + 10,
674 SNDRV_TIMER_EVENT_MPAUSE = SNDRV_TIMER_EVENT_PAUSE + 10,
677 struct sndrv_timer_tread {
678 enum sndrv_timer_event event;
679 struct timespec tstamp;
683 /****************************************************************************
685 * Section for driver control interface - /dev/snd/control? *
687 ****************************************************************************/
689 #define SNDRV_CTL_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 3)
691 struct sndrv_ctl_card_info {
692 int card; /* card number */
693 int pad; /* reserved for future (was type) */
694 unsigned char id[16]; /* ID of card (user selectable) */
695 unsigned char driver[16]; /* Driver name */
696 unsigned char name[32]; /* Short name of soundcard */
697 unsigned char longname[80]; /* name + info text about soundcard */
698 unsigned char reserved_[16]; /* reserved for future (was ID of mixer) */
699 unsigned char mixername[80]; /* visual mixer identification */
700 unsigned char components[80]; /* card components / fine identification, delimited with one space (AC97 etc..) */
701 unsigned char reserved[48]; /* reserved for future */
704 enum sndrv_ctl_elem_type {
705 SNDRV_CTL_ELEM_TYPE_NONE = 0, /* invalid */
706 SNDRV_CTL_ELEM_TYPE_BOOLEAN, /* boolean type */
707 SNDRV_CTL_ELEM_TYPE_INTEGER, /* integer type */
708 SNDRV_CTL_ELEM_TYPE_ENUMERATED, /* enumerated type */
709 SNDRV_CTL_ELEM_TYPE_BYTES, /* byte array */
710 SNDRV_CTL_ELEM_TYPE_IEC958, /* IEC958 (S/PDIF) setup */
711 SNDRV_CTL_ELEM_TYPE_INTEGER64, /* 64-bit integer type */
712 SNDRV_CTL_ELEM_TYPE_LAST = SNDRV_CTL_ELEM_TYPE_INTEGER64,
715 enum sndrv_ctl_elem_iface {
716 SNDRV_CTL_ELEM_IFACE_CARD = 0, /* global control */
717 SNDRV_CTL_ELEM_IFACE_HWDEP, /* hardware dependent device */
718 SNDRV_CTL_ELEM_IFACE_MIXER, /* virtual mixer device */
719 SNDRV_CTL_ELEM_IFACE_PCM, /* PCM device */
720 SNDRV_CTL_ELEM_IFACE_RAWMIDI, /* RawMidi device */
721 SNDRV_CTL_ELEM_IFACE_TIMER, /* timer device */
722 SNDRV_CTL_ELEM_IFACE_SEQUENCER, /* sequencer client */
723 SNDRV_CTL_ELEM_IFACE_LAST = SNDRV_CTL_ELEM_IFACE_SEQUENCER,
726 #define SNDRV_CTL_ELEM_ACCESS_READ (1<<0)
727 #define SNDRV_CTL_ELEM_ACCESS_WRITE (1<<1)
728 #define SNDRV_CTL_ELEM_ACCESS_READWRITE (SNDRV_CTL_ELEM_ACCESS_READ|SNDRV_CTL_ELEM_ACCESS_WRITE)
729 #define SNDRV_CTL_ELEM_ACCESS_VOLATILE (1<<2) /* control value may be changed without a notification */
730 #define SNDRV_CTL_ELEM_ACCESS_TIMESTAMP (1<<2) /* when was control changed */
731 #define SNDRV_CTL_ELEM_ACCESS_INACTIVE (1<<8) /* control does actually nothing, but may be updated */
732 #define SNDRV_CTL_ELEM_ACCESS_LOCK (1<<9) /* write lock */
733 #define SNDRV_CTL_ELEM_ACCESS_OWNER (1<<10) /* write lock owner */
734 #define SNDRV_CTL_ELEM_ACCESS_USER (1<<29) /* user space element */
735 #define SNDRV_CTL_ELEM_ACCESS_DINDIRECT (1<<30) /* indirect access for matrix dimensions in the info structure */
736 #define SNDRV_CTL_ELEM_ACCESS_INDIRECT (1<<31) /* indirect access for element value in the value structure */
738 /* for further details see the ACPI and PCI power management specification */
739 #define SNDRV_CTL_POWER_D0 0x0000 /* full On */
740 #define SNDRV_CTL_POWER_D1 0x0100 /* partial On */
741 #define SNDRV_CTL_POWER_D2 0x0200 /* partial On */
742 #define SNDRV_CTL_POWER_D3 0x0300 /* Off */
743 #define SNDRV_CTL_POWER_D3hot (SNDRV_CTL_POWER_D3|0x0000) /* Off, with power */
744 #define SNDRV_CTL_POWER_D3cold (SNDRV_CTL_POWER_D3|0x0001) /* Off, without power */
746 struct sndrv_ctl_elem_id {
747 unsigned int numid; /* numeric identifier, zero = invalid */
748 enum sndrv_ctl_elem_iface iface; /* interface identifier */
749 unsigned int device; /* device/client number */
750 unsigned int subdevice; /* subdevice (substream) number */
751 unsigned char name[44]; /* ASCII name of item */
752 unsigned int index; /* index of item */
755 struct sndrv_ctl_elem_list {
756 unsigned int offset; /* W: first element ID to get */
757 unsigned int space; /* W: count of element IDs to get */
758 unsigned int used; /* R: count of element IDs set */
759 unsigned int count; /* R: count of all elements */
760 struct sndrv_ctl_elem_id *pids; /* R: IDs */
761 unsigned char reserved[50];
764 struct sndrv_ctl_elem_info {
765 struct sndrv_ctl_elem_id id; /* W: element ID */
766 enum sndrv_ctl_elem_type type; /* R: value type - SNDRV_CTL_ELEM_TYPE_* */
767 unsigned int access; /* R: value access (bitmask) - SNDRV_CTL_ELEM_ACCESS_* */
768 unsigned int count; /* count of values */
769 pid_t owner; /* owner's PID of this control */
772 long min; /* R: minimum value */
773 long max; /* R: maximum value */
774 long step; /* R: step (0 variable) */
777 long long min; /* R: minimum value */
778 long long max; /* R: maximum value */
779 long long step; /* R: step (0 variable) */
782 unsigned int items; /* R: number of items */
783 unsigned int item; /* W: item number */
784 char name[64]; /* R: value name */
786 unsigned char reserved[128];
789 unsigned short d[4]; /* dimensions */
790 unsigned short *d_ptr; /* indirect */
792 unsigned char reserved[64-4*sizeof(unsigned short)];
795 struct sndrv_ctl_elem_value {
796 struct sndrv_ctl_elem_id id; /* W: element ID */
797 unsigned int indirect: 1; /* W: use indirect pointer (xxx_ptr member) */
805 long long *value_ptr;
808 unsigned int item[128];
809 unsigned int *item_ptr;
812 unsigned char data[512];
813 unsigned char *data_ptr;
815 struct sndrv_aes_iec958 iec958;
817 struct timespec tstamp;
818 unsigned char reserved[128-sizeof(struct timespec)];
822 SNDRV_CTL_IOCTL_PVERSION = _IOR('U', 0x00, int),
823 SNDRV_CTL_IOCTL_CARD_INFO = _IOR('U', 0x01, struct sndrv_ctl_card_info),
824 SNDRV_CTL_IOCTL_ELEM_LIST = _IOWR('U', 0x10, struct sndrv_ctl_elem_list),
825 SNDRV_CTL_IOCTL_ELEM_INFO = _IOWR('U', 0x11, struct sndrv_ctl_elem_info),
826 SNDRV_CTL_IOCTL_ELEM_READ = _IOWR('U', 0x12, struct sndrv_ctl_elem_value),
827 SNDRV_CTL_IOCTL_ELEM_WRITE = _IOWR('U', 0x13, struct sndrv_ctl_elem_value),
828 SNDRV_CTL_IOCTL_ELEM_LOCK = _IOW('U', 0x14, struct sndrv_ctl_elem_id),
829 SNDRV_CTL_IOCTL_ELEM_UNLOCK = _IOW('U', 0x15, struct sndrv_ctl_elem_id),
830 SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS = _IOWR('U', 0x16, int),
831 SNDRV_CTL_IOCTL_ELEM_ADD = _IOWR('U', 0x17, struct sndrv_ctl_elem_info),
832 SNDRV_CTL_IOCTL_ELEM_REPLACE = _IOWR('U', 0x18, struct sndrv_ctl_elem_info),
833 SNDRV_CTL_IOCTL_ELEM_REMOVE = _IOWR('U', 0x19, struct sndrv_ctl_elem_id),
834 SNDRV_CTL_IOCTL_HWDEP_NEXT_DEVICE = _IOWR('U', 0x20, int),
835 SNDRV_CTL_IOCTL_HWDEP_INFO = _IOR('U', 0x21, struct sndrv_hwdep_info),
836 SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE = _IOR('U', 0x30, int),
837 SNDRV_CTL_IOCTL_PCM_INFO = _IOWR('U', 0x31, struct sndrv_pcm_info),
838 SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE = _IOW('U', 0x32, int),
839 SNDRV_CTL_IOCTL_RAWMIDI_NEXT_DEVICE = _IOWR('U', 0x40, int),
840 SNDRV_CTL_IOCTL_RAWMIDI_INFO = _IOWR('U', 0x41, struct sndrv_rawmidi_info),
841 SNDRV_CTL_IOCTL_RAWMIDI_PREFER_SUBDEVICE = _IOW('U', 0x42, int),
842 SNDRV_CTL_IOCTL_POWER = _IOWR('U', 0xd0, int),
843 SNDRV_CTL_IOCTL_POWER_STATE = _IOR('U', 0xd1, int),
850 enum sndrv_ctl_event_type {
851 SNDRV_CTL_EVENT_ELEM = 0,
852 SNDRV_CTL_EVENT_LAST = SNDRV_CTL_EVENT_ELEM,
855 #define SNDRV_CTL_EVENT_MASK_VALUE (1<<0) /* element value was changed */
856 #define SNDRV_CTL_EVENT_MASK_INFO (1<<1) /* element info was changed */
857 #define SNDRV_CTL_EVENT_MASK_ADD (1<<2) /* element was added */
858 #define SNDRV_CTL_EVENT_MASK_REMOVE (~0U) /* element was removed */
860 struct sndrv_ctl_event {
861 enum sndrv_ctl_event_type type; /* event type - SNDRV_CTL_EVENT_* */
865 struct sndrv_ctl_elem_id id;
867 unsigned char data8[60];
875 #define SNDRV_CTL_NAME_NONE ""
876 #define SNDRV_CTL_NAME_PLAYBACK "Playback "
877 #define SNDRV_CTL_NAME_CAPTURE "Capture "
879 #define SNDRV_CTL_NAME_IEC958_NONE ""
880 #define SNDRV_CTL_NAME_IEC958_SWITCH "Switch"
881 #define SNDRV_CTL_NAME_IEC958_VOLUME "Volume"
882 #define SNDRV_CTL_NAME_IEC958_DEFAULT "Default"
883 #define SNDRV_CTL_NAME_IEC958_MASK "Mask"
884 #define SNDRV_CTL_NAME_IEC958_CON_MASK "Con Mask"
885 #define SNDRV_CTL_NAME_IEC958_PRO_MASK "Pro Mask"
886 #define SNDRV_CTL_NAME_IEC958_PCM_STREAM "PCM Stream"
887 #define SNDRV_CTL_NAME_IEC958(expl,direction,what) "IEC958 " expl SNDRV_CTL_NAME_##direction SNDRV_CTL_NAME_IEC958_##what
894 const struct iovec *vector;
899 SNDRV_IOCTL_READV = _IOW('K', 0x00, struct sndrv_xferv),
900 SNDRV_IOCTL_WRITEV = _IOW('K', 0x01, struct sndrv_xferv),
903 #endif /* __SOUND_ASOUND_H */