new buffering logic part 1
[cor_2_6_31.git] / include / sound / asound.h
blob82aed3f47534f3d47d53930e4869c9285de5652d
1 /*
2 * Advanced Linux Sound Architecture - ALSA - Driver
3 * Copyright (c) 1994-2003 by Jaroslav Kysela <perex@perex.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 #include <linux/types.h>
28 #ifdef __KERNEL__
29 #include <linux/ioctl.h>
30 #include <linux/time.h>
31 #include <asm/byteorder.h>
33 #ifdef __LITTLE_ENDIAN
34 #define SNDRV_LITTLE_ENDIAN
35 #else
36 #ifdef __BIG_ENDIAN
37 #define SNDRV_BIG_ENDIAN
38 #else
39 #error "Unsupported endian..."
40 #endif
41 #endif
43 #endif /* __KERNEL__ **/
46 * protocol version
49 #define SNDRV_PROTOCOL_VERSION(major, minor, subminor) (((major)<<16)|((minor)<<8)|(subminor))
50 #define SNDRV_PROTOCOL_MAJOR(version) (((version)>>16)&0xffff)
51 #define SNDRV_PROTOCOL_MINOR(version) (((version)>>8)&0xff)
52 #define SNDRV_PROTOCOL_MICRO(version) ((version)&0xff)
53 #define SNDRV_PROTOCOL_INCOMPATIBLE(kversion, uversion) \
54 (SNDRV_PROTOCOL_MAJOR(kversion) != SNDRV_PROTOCOL_MAJOR(uversion) || \
55 (SNDRV_PROTOCOL_MAJOR(kversion) == SNDRV_PROTOCOL_MAJOR(uversion) && \
56 SNDRV_PROTOCOL_MINOR(kversion) != SNDRV_PROTOCOL_MINOR(uversion)))
58 /****************************************************************************
59 * *
60 * Digital audio interface *
61 * *
62 ****************************************************************************/
64 struct snd_aes_iec958 {
65 unsigned char status[24]; /* AES/IEC958 channel status bits */
66 unsigned char subcode[147]; /* AES/IEC958 subcode bits */
67 unsigned char pad; /* nothing */
68 unsigned char dig_subframe[4]; /* AES/IEC958 subframe bits */
71 /****************************************************************************
72 * *
73 * Section for driver hardware dependent interface - /dev/snd/hw? *
74 * *
75 ****************************************************************************/
77 #define SNDRV_HWDEP_VERSION SNDRV_PROTOCOL_VERSION(1, 0, 1)
79 enum {
80 SNDRV_HWDEP_IFACE_OPL2 = 0,
81 SNDRV_HWDEP_IFACE_OPL3,
82 SNDRV_HWDEP_IFACE_OPL4,
83 SNDRV_HWDEP_IFACE_SB16CSP, /* Creative Signal Processor */
84 SNDRV_HWDEP_IFACE_EMU10K1, /* FX8010 processor in EMU10K1 chip */
85 SNDRV_HWDEP_IFACE_YSS225, /* Yamaha FX processor */
86 SNDRV_HWDEP_IFACE_ICS2115, /* Wavetable synth */
87 SNDRV_HWDEP_IFACE_SSCAPE, /* Ensoniq SoundScape ISA card (MC68EC000) */
88 SNDRV_HWDEP_IFACE_VX, /* Digigram VX cards */
89 SNDRV_HWDEP_IFACE_MIXART, /* Digigram miXart cards */
90 SNDRV_HWDEP_IFACE_USX2Y, /* Tascam US122, US224 & US428 usb */
91 SNDRV_HWDEP_IFACE_EMUX_WAVETABLE, /* EmuX wavetable */
92 SNDRV_HWDEP_IFACE_BLUETOOTH, /* Bluetooth audio */
93 SNDRV_HWDEP_IFACE_USX2Y_PCM, /* Tascam US122, US224 & US428 rawusb pcm */
94 SNDRV_HWDEP_IFACE_PCXHR, /* Digigram PCXHR */
95 SNDRV_HWDEP_IFACE_SB_RC, /* SB Extigy/Audigy2NX remote control */
96 SNDRV_HWDEP_IFACE_HDA, /* HD-audio */
97 SNDRV_HWDEP_IFACE_USB_STREAM, /* direct access to usb stream */
99 /* Don't forget to change the following: */
100 SNDRV_HWDEP_IFACE_LAST = SNDRV_HWDEP_IFACE_USB_STREAM
103 struct snd_hwdep_info {
104 unsigned int device; /* WR: device number */
105 int card; /* R: card number */
106 unsigned char id[64]; /* ID (user selectable) */
107 unsigned char name[80]; /* hwdep name */
108 int iface; /* hwdep interface */
109 unsigned char reserved[64]; /* reserved for future */
112 /* generic DSP loader */
113 struct snd_hwdep_dsp_status {
114 unsigned int version; /* R: driver-specific version */
115 unsigned char id[32]; /* R: driver-specific ID string */
116 unsigned int num_dsps; /* R: number of DSP images to transfer */
117 unsigned int dsp_loaded; /* R: bit flags indicating the loaded DSPs */
118 unsigned int chip_ready; /* R: 1 = initialization finished */
119 unsigned char reserved[16]; /* reserved for future use */
122 struct snd_hwdep_dsp_image {
123 unsigned int index; /* W: DSP index */
124 unsigned char name[64]; /* W: ID (e.g. file name) */
125 unsigned char __user *image; /* W: binary image */
126 size_t length; /* W: size of image in bytes */
127 unsigned long driver_data; /* W: driver-specific data */
130 #define SNDRV_HWDEP_IOCTL_PVERSION _IOR ('H', 0x00, int)
131 #define SNDRV_HWDEP_IOCTL_INFO _IOR ('H', 0x01, struct snd_hwdep_info)
132 #define SNDRV_HWDEP_IOCTL_DSP_STATUS _IOR('H', 0x02, struct snd_hwdep_dsp_status)
133 #define SNDRV_HWDEP_IOCTL_DSP_LOAD _IOW('H', 0x03, struct snd_hwdep_dsp_image)
135 /*****************************************************************************
137 * Digital Audio (PCM) interface - /dev/snd/pcm?? *
139 *****************************************************************************/
141 #define SNDRV_PCM_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 9)
143 typedef unsigned long snd_pcm_uframes_t;
144 typedef signed long snd_pcm_sframes_t;
146 enum {
147 SNDRV_PCM_CLASS_GENERIC = 0, /* standard mono or stereo device */
148 SNDRV_PCM_CLASS_MULTI, /* multichannel device */
149 SNDRV_PCM_CLASS_MODEM, /* software modem class */
150 SNDRV_PCM_CLASS_DIGITIZER, /* digitizer class */
151 /* Don't forget to change the following: */
152 SNDRV_PCM_CLASS_LAST = SNDRV_PCM_CLASS_DIGITIZER,
155 enum {
156 SNDRV_PCM_SUBCLASS_GENERIC_MIX = 0, /* mono or stereo subdevices are mixed together */
157 SNDRV_PCM_SUBCLASS_MULTI_MIX, /* multichannel subdevices are mixed together */
158 /* Don't forget to change the following: */
159 SNDRV_PCM_SUBCLASS_LAST = SNDRV_PCM_SUBCLASS_MULTI_MIX,
162 enum {
163 SNDRV_PCM_STREAM_PLAYBACK = 0,
164 SNDRV_PCM_STREAM_CAPTURE,
165 SNDRV_PCM_STREAM_LAST = SNDRV_PCM_STREAM_CAPTURE,
168 typedef int __bitwise snd_pcm_access_t;
169 #define SNDRV_PCM_ACCESS_MMAP_INTERLEAVED ((__force snd_pcm_access_t) 0) /* interleaved mmap */
170 #define SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED ((__force snd_pcm_access_t) 1) /* noninterleaved mmap */
171 #define SNDRV_PCM_ACCESS_MMAP_COMPLEX ((__force snd_pcm_access_t) 2) /* complex mmap */
172 #define SNDRV_PCM_ACCESS_RW_INTERLEAVED ((__force snd_pcm_access_t) 3) /* readi/writei */
173 #define SNDRV_PCM_ACCESS_RW_NONINTERLEAVED ((__force snd_pcm_access_t) 4) /* readn/writen */
174 #define SNDRV_PCM_ACCESS_LAST SNDRV_PCM_ACCESS_RW_NONINTERLEAVED
176 typedef int __bitwise snd_pcm_format_t;
177 #define SNDRV_PCM_FORMAT_S8 ((__force snd_pcm_format_t) 0)
178 #define SNDRV_PCM_FORMAT_U8 ((__force snd_pcm_format_t) 1)
179 #define SNDRV_PCM_FORMAT_S16_LE ((__force snd_pcm_format_t) 2)
180 #define SNDRV_PCM_FORMAT_S16_BE ((__force snd_pcm_format_t) 3)
181 #define SNDRV_PCM_FORMAT_U16_LE ((__force snd_pcm_format_t) 4)
182 #define SNDRV_PCM_FORMAT_U16_BE ((__force snd_pcm_format_t) 5)
183 #define SNDRV_PCM_FORMAT_S24_LE ((__force snd_pcm_format_t) 6) /* low three bytes */
184 #define SNDRV_PCM_FORMAT_S24_BE ((__force snd_pcm_format_t) 7) /* low three bytes */
185 #define SNDRV_PCM_FORMAT_U24_LE ((__force snd_pcm_format_t) 8) /* low three bytes */
186 #define SNDRV_PCM_FORMAT_U24_BE ((__force snd_pcm_format_t) 9) /* low three bytes */
187 #define SNDRV_PCM_FORMAT_S32_LE ((__force snd_pcm_format_t) 10)
188 #define SNDRV_PCM_FORMAT_S32_BE ((__force snd_pcm_format_t) 11)
189 #define SNDRV_PCM_FORMAT_U32_LE ((__force snd_pcm_format_t) 12)
190 #define SNDRV_PCM_FORMAT_U32_BE ((__force snd_pcm_format_t) 13)
191 #define SNDRV_PCM_FORMAT_FLOAT_LE ((__force snd_pcm_format_t) 14) /* 4-byte float, IEEE-754 32-bit, range -1.0 to 1.0 */
192 #define SNDRV_PCM_FORMAT_FLOAT_BE ((__force snd_pcm_format_t) 15) /* 4-byte float, IEEE-754 32-bit, range -1.0 to 1.0 */
193 #define SNDRV_PCM_FORMAT_FLOAT64_LE ((__force snd_pcm_format_t) 16) /* 8-byte float, IEEE-754 64-bit, range -1.0 to 1.0 */
194 #define SNDRV_PCM_FORMAT_FLOAT64_BE ((__force snd_pcm_format_t) 17) /* 8-byte float, IEEE-754 64-bit, range -1.0 to 1.0 */
195 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE ((__force snd_pcm_format_t) 18) /* IEC-958 subframe, Little Endian */
196 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE ((__force snd_pcm_format_t) 19) /* IEC-958 subframe, Big Endian */
197 #define SNDRV_PCM_FORMAT_MU_LAW ((__force snd_pcm_format_t) 20)
198 #define SNDRV_PCM_FORMAT_A_LAW ((__force snd_pcm_format_t) 21)
199 #define SNDRV_PCM_FORMAT_IMA_ADPCM ((__force snd_pcm_format_t) 22)
200 #define SNDRV_PCM_FORMAT_MPEG ((__force snd_pcm_format_t) 23)
201 #define SNDRV_PCM_FORMAT_GSM ((__force snd_pcm_format_t) 24)
202 #define SNDRV_PCM_FORMAT_SPECIAL ((__force snd_pcm_format_t) 31)
203 #define SNDRV_PCM_FORMAT_S24_3LE ((__force snd_pcm_format_t) 32) /* in three bytes */
204 #define SNDRV_PCM_FORMAT_S24_3BE ((__force snd_pcm_format_t) 33) /* in three bytes */
205 #define SNDRV_PCM_FORMAT_U24_3LE ((__force snd_pcm_format_t) 34) /* in three bytes */
206 #define SNDRV_PCM_FORMAT_U24_3BE ((__force snd_pcm_format_t) 35) /* in three bytes */
207 #define SNDRV_PCM_FORMAT_S20_3LE ((__force snd_pcm_format_t) 36) /* in three bytes */
208 #define SNDRV_PCM_FORMAT_S20_3BE ((__force snd_pcm_format_t) 37) /* in three bytes */
209 #define SNDRV_PCM_FORMAT_U20_3LE ((__force snd_pcm_format_t) 38) /* in three bytes */
210 #define SNDRV_PCM_FORMAT_U20_3BE ((__force snd_pcm_format_t) 39) /* in three bytes */
211 #define SNDRV_PCM_FORMAT_S18_3LE ((__force snd_pcm_format_t) 40) /* in three bytes */
212 #define SNDRV_PCM_FORMAT_S18_3BE ((__force snd_pcm_format_t) 41) /* in three bytes */
213 #define SNDRV_PCM_FORMAT_U18_3LE ((__force snd_pcm_format_t) 42) /* in three bytes */
214 #define SNDRV_PCM_FORMAT_U18_3BE ((__force snd_pcm_format_t) 43) /* in three bytes */
215 #define SNDRV_PCM_FORMAT_LAST SNDRV_PCM_FORMAT_U18_3BE
217 #ifdef SNDRV_LITTLE_ENDIAN
218 #define SNDRV_PCM_FORMAT_S16 SNDRV_PCM_FORMAT_S16_LE
219 #define SNDRV_PCM_FORMAT_U16 SNDRV_PCM_FORMAT_U16_LE
220 #define SNDRV_PCM_FORMAT_S24 SNDRV_PCM_FORMAT_S24_LE
221 #define SNDRV_PCM_FORMAT_U24 SNDRV_PCM_FORMAT_U24_LE
222 #define SNDRV_PCM_FORMAT_S32 SNDRV_PCM_FORMAT_S32_LE
223 #define SNDRV_PCM_FORMAT_U32 SNDRV_PCM_FORMAT_U32_LE
224 #define SNDRV_PCM_FORMAT_FLOAT SNDRV_PCM_FORMAT_FLOAT_LE
225 #define SNDRV_PCM_FORMAT_FLOAT64 SNDRV_PCM_FORMAT_FLOAT64_LE
226 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE
227 #endif
228 #ifdef SNDRV_BIG_ENDIAN
229 #define SNDRV_PCM_FORMAT_S16 SNDRV_PCM_FORMAT_S16_BE
230 #define SNDRV_PCM_FORMAT_U16 SNDRV_PCM_FORMAT_U16_BE
231 #define SNDRV_PCM_FORMAT_S24 SNDRV_PCM_FORMAT_S24_BE
232 #define SNDRV_PCM_FORMAT_U24 SNDRV_PCM_FORMAT_U24_BE
233 #define SNDRV_PCM_FORMAT_S32 SNDRV_PCM_FORMAT_S32_BE
234 #define SNDRV_PCM_FORMAT_U32 SNDRV_PCM_FORMAT_U32_BE
235 #define SNDRV_PCM_FORMAT_FLOAT SNDRV_PCM_FORMAT_FLOAT_BE
236 #define SNDRV_PCM_FORMAT_FLOAT64 SNDRV_PCM_FORMAT_FLOAT64_BE
237 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE
238 #endif
240 typedef int __bitwise snd_pcm_subformat_t;
241 #define SNDRV_PCM_SUBFORMAT_STD ((__force snd_pcm_subformat_t) 0)
242 #define SNDRV_PCM_SUBFORMAT_LAST SNDRV_PCM_SUBFORMAT_STD
244 #define SNDRV_PCM_INFO_MMAP 0x00000001 /* hardware supports mmap */
245 #define SNDRV_PCM_INFO_MMAP_VALID 0x00000002 /* period data are valid during transfer */
246 #define SNDRV_PCM_INFO_DOUBLE 0x00000004 /* Double buffering needed for PCM start/stop */
247 #define SNDRV_PCM_INFO_BATCH 0x00000010 /* double buffering */
248 #define SNDRV_PCM_INFO_INTERLEAVED 0x00000100 /* channels are interleaved */
249 #define SNDRV_PCM_INFO_NONINTERLEAVED 0x00000200 /* channels are not interleaved */
250 #define SNDRV_PCM_INFO_COMPLEX 0x00000400 /* complex frame organization (mmap only) */
251 #define SNDRV_PCM_INFO_BLOCK_TRANSFER 0x00010000 /* hardware transfer block of samples */
252 #define SNDRV_PCM_INFO_OVERRANGE 0x00020000 /* hardware supports ADC (capture) overrange detection */
253 #define SNDRV_PCM_INFO_RESUME 0x00040000 /* hardware supports stream resume after suspend */
254 #define SNDRV_PCM_INFO_PAUSE 0x00080000 /* pause ioctl is supported */
255 #define SNDRV_PCM_INFO_HALF_DUPLEX 0x00100000 /* only half duplex */
256 #define SNDRV_PCM_INFO_JOINT_DUPLEX 0x00200000 /* playback and capture stream are somewhat correlated */
257 #define SNDRV_PCM_INFO_SYNC_START 0x00400000 /* pcm support some kind of sync go */
258 #define SNDRV_PCM_INFO_FIFO_IN_FRAMES 0x80000000 /* internal kernel flag - FIFO size is in frames */
260 typedef int __bitwise snd_pcm_state_t;
261 #define SNDRV_PCM_STATE_OPEN ((__force snd_pcm_state_t) 0) /* stream is open */
262 #define SNDRV_PCM_STATE_SETUP ((__force snd_pcm_state_t) 1) /* stream has a setup */
263 #define SNDRV_PCM_STATE_PREPARED ((__force snd_pcm_state_t) 2) /* stream is ready to start */
264 #define SNDRV_PCM_STATE_RUNNING ((__force snd_pcm_state_t) 3) /* stream is running */
265 #define SNDRV_PCM_STATE_XRUN ((__force snd_pcm_state_t) 4) /* stream reached an xrun */
266 #define SNDRV_PCM_STATE_DRAINING ((__force snd_pcm_state_t) 5) /* stream is draining */
267 #define SNDRV_PCM_STATE_PAUSED ((__force snd_pcm_state_t) 6) /* stream is paused */
268 #define SNDRV_PCM_STATE_SUSPENDED ((__force snd_pcm_state_t) 7) /* hardware is suspended */
269 #define SNDRV_PCM_STATE_DISCONNECTED ((__force snd_pcm_state_t) 8) /* hardware is disconnected */
270 #define SNDRV_PCM_STATE_LAST SNDRV_PCM_STATE_DISCONNECTED
272 enum {
273 SNDRV_PCM_MMAP_OFFSET_DATA = 0x00000000,
274 SNDRV_PCM_MMAP_OFFSET_STATUS = 0x80000000,
275 SNDRV_PCM_MMAP_OFFSET_CONTROL = 0x81000000,
278 union snd_pcm_sync_id {
279 unsigned char id[16];
280 unsigned short id16[8];
281 unsigned int id32[4];
284 struct snd_pcm_info {
285 unsigned int device; /* RO/WR (control): device number */
286 unsigned int subdevice; /* RO/WR (control): subdevice number */
287 int stream; /* RO/WR (control): stream direction */
288 int card; /* R: card number */
289 unsigned char id[64]; /* ID (user selectable) */
290 unsigned char name[80]; /* name of this device */
291 unsigned char subname[32]; /* subdevice name */
292 int dev_class; /* SNDRV_PCM_CLASS_* */
293 int dev_subclass; /* SNDRV_PCM_SUBCLASS_* */
294 unsigned int subdevices_count;
295 unsigned int subdevices_avail;
296 union snd_pcm_sync_id sync; /* hardware synchronization ID */
297 unsigned char reserved[64]; /* reserved for future... */
300 typedef int snd_pcm_hw_param_t;
301 #define SNDRV_PCM_HW_PARAM_ACCESS 0 /* Access type */
302 #define SNDRV_PCM_HW_PARAM_FORMAT 1 /* Format */
303 #define SNDRV_PCM_HW_PARAM_SUBFORMAT 2 /* Subformat */
304 #define SNDRV_PCM_HW_PARAM_FIRST_MASK SNDRV_PCM_HW_PARAM_ACCESS
305 #define SNDRV_PCM_HW_PARAM_LAST_MASK SNDRV_PCM_HW_PARAM_SUBFORMAT
307 #define SNDRV_PCM_HW_PARAM_SAMPLE_BITS 8 /* Bits per sample */
308 #define SNDRV_PCM_HW_PARAM_FRAME_BITS 9 /* Bits per frame */
309 #define SNDRV_PCM_HW_PARAM_CHANNELS 10 /* Channels */
310 #define SNDRV_PCM_HW_PARAM_RATE 11 /* Approx rate */
311 #define SNDRV_PCM_HW_PARAM_PERIOD_TIME 12 /* Approx distance between
312 * interrupts in us
314 #define SNDRV_PCM_HW_PARAM_PERIOD_SIZE 13 /* Approx frames between
315 * interrupts
317 #define SNDRV_PCM_HW_PARAM_PERIOD_BYTES 14 /* Approx bytes between
318 * interrupts
320 #define SNDRV_PCM_HW_PARAM_PERIODS 15 /* Approx interrupts per
321 * buffer
323 #define SNDRV_PCM_HW_PARAM_BUFFER_TIME 16 /* Approx duration of buffer
324 * in us
326 #define SNDRV_PCM_HW_PARAM_BUFFER_SIZE 17 /* Size of buffer in frames */
327 #define SNDRV_PCM_HW_PARAM_BUFFER_BYTES 18 /* Size of buffer in bytes */
328 #define SNDRV_PCM_HW_PARAM_TICK_TIME 19 /* Approx tick duration in us */
329 #define SNDRV_PCM_HW_PARAM_FIRST_INTERVAL SNDRV_PCM_HW_PARAM_SAMPLE_BITS
330 #define SNDRV_PCM_HW_PARAM_LAST_INTERVAL SNDRV_PCM_HW_PARAM_TICK_TIME
332 #define SNDRV_PCM_HW_PARAMS_NORESAMPLE (1<<0) /* avoid rate resampling */
334 struct snd_interval {
335 unsigned int min, max;
336 unsigned int openmin:1,
337 openmax:1,
338 integer:1,
339 empty:1;
342 #define SNDRV_MASK_MAX 256
344 struct snd_mask {
345 __u32 bits[(SNDRV_MASK_MAX+31)/32];
348 struct snd_pcm_hw_params {
349 unsigned int flags;
350 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
351 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
352 struct snd_mask mres[5]; /* reserved masks */
353 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
354 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
355 struct snd_interval ires[9]; /* reserved intervals */
356 unsigned int rmask; /* W: requested masks */
357 unsigned int cmask; /* R: changed masks */
358 unsigned int info; /* R: Info flags for returned setup */
359 unsigned int msbits; /* R: used most significant bits */
360 unsigned int rate_num; /* R: rate numerator */
361 unsigned int rate_den; /* R: rate denominator */
362 snd_pcm_uframes_t fifo_size; /* R: chip FIFO size in frames */
363 unsigned char reserved[64]; /* reserved for future */
366 enum {
367 SNDRV_PCM_TSTAMP_NONE = 0,
368 SNDRV_PCM_TSTAMP_ENABLE,
369 SNDRV_PCM_TSTAMP_LAST = SNDRV_PCM_TSTAMP_ENABLE,
372 struct snd_pcm_sw_params {
373 int tstamp_mode; /* timestamp mode */
374 unsigned int period_step;
375 unsigned int sleep_min; /* min ticks to sleep */
376 snd_pcm_uframes_t avail_min; /* min avail frames for wakeup */
377 snd_pcm_uframes_t xfer_align; /* obsolete: xfer size need to be a multiple */
378 snd_pcm_uframes_t start_threshold; /* min hw_avail frames for automatic start */
379 snd_pcm_uframes_t stop_threshold; /* min avail frames for automatic stop */
380 snd_pcm_uframes_t silence_threshold; /* min distance from noise for silence filling */
381 snd_pcm_uframes_t silence_size; /* silence block size */
382 snd_pcm_uframes_t boundary; /* pointers wrap point */
383 unsigned char reserved[64]; /* reserved for future */
386 struct snd_pcm_channel_info {
387 unsigned int channel;
388 __kernel_off_t offset; /* mmap offset */
389 unsigned int first; /* offset to first sample in bits */
390 unsigned int step; /* samples distance in bits */
393 struct snd_pcm_status {
394 snd_pcm_state_t state; /* stream state */
395 struct timespec trigger_tstamp; /* time when stream was started/stopped/paused */
396 struct timespec tstamp; /* reference timestamp */
397 snd_pcm_uframes_t appl_ptr; /* appl ptr */
398 snd_pcm_uframes_t hw_ptr; /* hw ptr */
399 snd_pcm_sframes_t delay; /* current delay in frames */
400 snd_pcm_uframes_t avail; /* number of frames available */
401 snd_pcm_uframes_t avail_max; /* max frames available on hw since last status */
402 snd_pcm_uframes_t overrange; /* count of ADC (capture) overrange detections from last status */
403 snd_pcm_state_t suspended_state; /* suspended stream state */
404 unsigned char reserved[60]; /* must be filled with zero */
407 struct snd_pcm_mmap_status {
408 snd_pcm_state_t state; /* RO: state - SNDRV_PCM_STATE_XXXX */
409 int pad1; /* Needed for 64 bit alignment */
410 snd_pcm_uframes_t hw_ptr; /* RO: hw ptr (0...boundary-1) */
411 struct timespec tstamp; /* Timestamp */
412 snd_pcm_state_t suspended_state; /* RO: suspended stream state */
415 struct snd_pcm_mmap_control {
416 snd_pcm_uframes_t appl_ptr; /* RW: appl ptr (0...boundary-1) */
417 snd_pcm_uframes_t avail_min; /* RW: min available frames for wakeup */
420 #define SNDRV_PCM_SYNC_PTR_HWSYNC (1<<0) /* execute hwsync */
421 #define SNDRV_PCM_SYNC_PTR_APPL (1<<1) /* get appl_ptr from driver (r/w op) */
422 #define SNDRV_PCM_SYNC_PTR_AVAIL_MIN (1<<2) /* get avail_min from driver */
424 struct snd_pcm_sync_ptr {
425 unsigned int flags;
426 union {
427 struct snd_pcm_mmap_status status;
428 unsigned char reserved[64];
429 } s;
430 union {
431 struct snd_pcm_mmap_control control;
432 unsigned char reserved[64];
433 } c;
436 struct snd_xferi {
437 snd_pcm_sframes_t result;
438 void __user *buf;
439 snd_pcm_uframes_t frames;
442 struct snd_xfern {
443 snd_pcm_sframes_t result;
444 void __user * __user *bufs;
445 snd_pcm_uframes_t frames;
448 enum {
449 SNDRV_PCM_TSTAMP_TYPE_GETTIMEOFDAY = 0, /* gettimeofday equivalent */
450 SNDRV_PCM_TSTAMP_TYPE_MONOTONIC, /* posix_clock_monotonic equivalent */
451 SNDRV_PCM_TSTAMP_TYPE_LAST = SNDRV_PCM_TSTAMP_TYPE_MONOTONIC,
454 #define SNDRV_PCM_IOCTL_PVERSION _IOR('A', 0x00, int)
455 #define SNDRV_PCM_IOCTL_INFO _IOR('A', 0x01, struct snd_pcm_info)
456 #define SNDRV_PCM_IOCTL_TSTAMP _IOW('A', 0x02, int)
457 #define SNDRV_PCM_IOCTL_TTSTAMP _IOW('A', 0x03, int)
458 #define SNDRV_PCM_IOCTL_HW_REFINE _IOWR('A', 0x10, struct snd_pcm_hw_params)
459 #define SNDRV_PCM_IOCTL_HW_PARAMS _IOWR('A', 0x11, struct snd_pcm_hw_params)
460 #define SNDRV_PCM_IOCTL_HW_FREE _IO('A', 0x12)
461 #define SNDRV_PCM_IOCTL_SW_PARAMS _IOWR('A', 0x13, struct snd_pcm_sw_params)
462 #define SNDRV_PCM_IOCTL_STATUS _IOR('A', 0x20, struct snd_pcm_status)
463 #define SNDRV_PCM_IOCTL_DELAY _IOR('A', 0x21, snd_pcm_sframes_t)
464 #define SNDRV_PCM_IOCTL_HWSYNC _IO('A', 0x22)
465 #define SNDRV_PCM_IOCTL_SYNC_PTR _IOWR('A', 0x23, struct snd_pcm_sync_ptr)
466 #define SNDRV_PCM_IOCTL_CHANNEL_INFO _IOR('A', 0x32, struct snd_pcm_channel_info)
467 #define SNDRV_PCM_IOCTL_PREPARE _IO('A', 0x40)
468 #define SNDRV_PCM_IOCTL_RESET _IO('A', 0x41)
469 #define SNDRV_PCM_IOCTL_START _IO('A', 0x42)
470 #define SNDRV_PCM_IOCTL_DROP _IO('A', 0x43)
471 #define SNDRV_PCM_IOCTL_DRAIN _IO('A', 0x44)
472 #define SNDRV_PCM_IOCTL_PAUSE _IOW('A', 0x45, int)
473 #define SNDRV_PCM_IOCTL_REWIND _IOW('A', 0x46, snd_pcm_uframes_t)
474 #define SNDRV_PCM_IOCTL_RESUME _IO('A', 0x47)
475 #define SNDRV_PCM_IOCTL_XRUN _IO('A', 0x48)
476 #define SNDRV_PCM_IOCTL_FORWARD _IOW('A', 0x49, snd_pcm_uframes_t)
477 #define SNDRV_PCM_IOCTL_WRITEI_FRAMES _IOW('A', 0x50, struct snd_xferi)
478 #define SNDRV_PCM_IOCTL_READI_FRAMES _IOR('A', 0x51, struct snd_xferi)
479 #define SNDRV_PCM_IOCTL_WRITEN_FRAMES _IOW('A', 0x52, struct snd_xfern)
480 #define SNDRV_PCM_IOCTL_READN_FRAMES _IOR('A', 0x53, struct snd_xfern)
481 #define SNDRV_PCM_IOCTL_LINK _IOW('A', 0x60, int)
482 #define SNDRV_PCM_IOCTL_UNLINK _IO('A', 0x61)
484 /*****************************************************************************
486 * MIDI v1.0 interface *
488 *****************************************************************************/
491 * Raw MIDI section - /dev/snd/midi??
494 #define SNDRV_RAWMIDI_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 0)
496 enum {
497 SNDRV_RAWMIDI_STREAM_OUTPUT = 0,
498 SNDRV_RAWMIDI_STREAM_INPUT,
499 SNDRV_RAWMIDI_STREAM_LAST = SNDRV_RAWMIDI_STREAM_INPUT,
502 #define SNDRV_RAWMIDI_INFO_OUTPUT 0x00000001
503 #define SNDRV_RAWMIDI_INFO_INPUT 0x00000002
504 #define SNDRV_RAWMIDI_INFO_DUPLEX 0x00000004
506 struct snd_rawmidi_info {
507 unsigned int device; /* RO/WR (control): device number */
508 unsigned int subdevice; /* RO/WR (control): subdevice number */
509 int stream; /* WR: stream */
510 int card; /* R: card number */
511 unsigned int flags; /* SNDRV_RAWMIDI_INFO_XXXX */
512 unsigned char id[64]; /* ID (user selectable) */
513 unsigned char name[80]; /* name of device */
514 unsigned char subname[32]; /* name of active or selected subdevice */
515 unsigned int subdevices_count;
516 unsigned int subdevices_avail;
517 unsigned char reserved[64]; /* reserved for future use */
520 struct snd_rawmidi_params {
521 int stream;
522 size_t buffer_size; /* queue size in bytes */
523 size_t avail_min; /* minimum avail bytes for wakeup */
524 unsigned int no_active_sensing: 1; /* do not send active sensing byte in close() */
525 unsigned char reserved[16]; /* reserved for future use */
528 struct snd_rawmidi_status {
529 int stream;
530 struct timespec tstamp; /* Timestamp */
531 size_t avail; /* available bytes */
532 size_t xruns; /* count of overruns since last status (in bytes) */
533 unsigned char reserved[16]; /* reserved for future use */
536 #define SNDRV_RAWMIDI_IOCTL_PVERSION _IOR('W', 0x00, int)
537 #define SNDRV_RAWMIDI_IOCTL_INFO _IOR('W', 0x01, struct snd_rawmidi_info)
538 #define SNDRV_RAWMIDI_IOCTL_PARAMS _IOWR('W', 0x10, struct snd_rawmidi_params)
539 #define SNDRV_RAWMIDI_IOCTL_STATUS _IOWR('W', 0x20, struct snd_rawmidi_status)
540 #define SNDRV_RAWMIDI_IOCTL_DROP _IOW('W', 0x30, int)
541 #define SNDRV_RAWMIDI_IOCTL_DRAIN _IOW('W', 0x31, int)
544 * Timer section - /dev/snd/timer
547 #define SNDRV_TIMER_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 5)
549 enum {
550 SNDRV_TIMER_CLASS_NONE = -1,
551 SNDRV_TIMER_CLASS_SLAVE = 0,
552 SNDRV_TIMER_CLASS_GLOBAL,
553 SNDRV_TIMER_CLASS_CARD,
554 SNDRV_TIMER_CLASS_PCM,
555 SNDRV_TIMER_CLASS_LAST = SNDRV_TIMER_CLASS_PCM,
558 /* slave timer classes */
559 enum {
560 SNDRV_TIMER_SCLASS_NONE = 0,
561 SNDRV_TIMER_SCLASS_APPLICATION,
562 SNDRV_TIMER_SCLASS_SEQUENCER, /* alias */
563 SNDRV_TIMER_SCLASS_OSS_SEQUENCER, /* alias */
564 SNDRV_TIMER_SCLASS_LAST = SNDRV_TIMER_SCLASS_OSS_SEQUENCER,
567 /* global timers (device member) */
568 #define SNDRV_TIMER_GLOBAL_SYSTEM 0
569 #define SNDRV_TIMER_GLOBAL_RTC 1
570 #define SNDRV_TIMER_GLOBAL_HPET 2
571 #define SNDRV_TIMER_GLOBAL_HRTIMER 3
573 /* info flags */
574 #define SNDRV_TIMER_FLG_SLAVE (1<<0) /* cannot be controlled */
576 struct snd_timer_id {
577 int dev_class;
578 int dev_sclass;
579 int card;
580 int device;
581 int subdevice;
584 struct snd_timer_ginfo {
585 struct snd_timer_id tid; /* requested timer ID */
586 unsigned int flags; /* timer flags - SNDRV_TIMER_FLG_* */
587 int card; /* card number */
588 unsigned char id[64]; /* timer identification */
589 unsigned char name[80]; /* timer name */
590 unsigned long reserved0; /* reserved for future use */
591 unsigned long resolution; /* average period resolution in ns */
592 unsigned long resolution_min; /* minimal period resolution in ns */
593 unsigned long resolution_max; /* maximal period resolution in ns */
594 unsigned int clients; /* active timer clients */
595 unsigned char reserved[32];
598 struct snd_timer_gparams {
599 struct snd_timer_id tid; /* requested timer ID */
600 unsigned long period_num; /* requested precise period duration (in seconds) - numerator */
601 unsigned long period_den; /* requested precise period duration (in seconds) - denominator */
602 unsigned char reserved[32];
605 struct snd_timer_gstatus {
606 struct snd_timer_id tid; /* requested timer ID */
607 unsigned long resolution; /* current period resolution in ns */
608 unsigned long resolution_num; /* precise current period resolution (in seconds) - numerator */
609 unsigned long resolution_den; /* precise current period resolution (in seconds) - denominator */
610 unsigned char reserved[32];
613 struct snd_timer_select {
614 struct snd_timer_id id; /* bind to timer ID */
615 unsigned char reserved[32]; /* reserved */
618 struct snd_timer_info {
619 unsigned int flags; /* timer flags - SNDRV_TIMER_FLG_* */
620 int card; /* card number */
621 unsigned char id[64]; /* timer identificator */
622 unsigned char name[80]; /* timer name */
623 unsigned long reserved0; /* reserved for future use */
624 unsigned long resolution; /* average period resolution in ns */
625 unsigned char reserved[64]; /* reserved */
628 #define SNDRV_TIMER_PSFLG_AUTO (1<<0) /* auto start, otherwise one-shot */
629 #define SNDRV_TIMER_PSFLG_EXCLUSIVE (1<<1) /* exclusive use, precise start/stop/pause/continue */
630 #define SNDRV_TIMER_PSFLG_EARLY_EVENT (1<<2) /* write early event to the poll queue */
632 struct snd_timer_params {
633 unsigned int flags; /* flags - SNDRV_MIXER_PSFLG_* */
634 unsigned int ticks; /* requested resolution in ticks */
635 unsigned int queue_size; /* total size of queue (32-1024) */
636 unsigned int reserved0; /* reserved, was: failure locations */
637 unsigned int filter; /* event filter (bitmask of SNDRV_TIMER_EVENT_*) */
638 unsigned char reserved[60]; /* reserved */
641 struct snd_timer_status {
642 struct timespec tstamp; /* Timestamp - last update */
643 unsigned int resolution; /* current period resolution in ns */
644 unsigned int lost; /* counter of master tick lost */
645 unsigned int overrun; /* count of read queue overruns */
646 unsigned int queue; /* used queue size */
647 unsigned char reserved[64]; /* reserved */
650 #define SNDRV_TIMER_IOCTL_PVERSION _IOR('T', 0x00, int)
651 #define SNDRV_TIMER_IOCTL_NEXT_DEVICE _IOWR('T', 0x01, struct snd_timer_id)
652 #define SNDRV_TIMER_IOCTL_TREAD _IOW('T', 0x02, int)
653 #define SNDRV_TIMER_IOCTL_GINFO _IOWR('T', 0x03, struct snd_timer_ginfo)
654 #define SNDRV_TIMER_IOCTL_GPARAMS _IOW('T', 0x04, struct snd_timer_gparams)
655 #define SNDRV_TIMER_IOCTL_GSTATUS _IOWR('T', 0x05, struct snd_timer_gstatus)
656 #define SNDRV_TIMER_IOCTL_SELECT _IOW('T', 0x10, struct snd_timer_select)
657 #define SNDRV_TIMER_IOCTL_INFO _IOR('T', 0x11, struct snd_timer_info)
658 #define SNDRV_TIMER_IOCTL_PARAMS _IOW('T', 0x12, struct snd_timer_params)
659 #define SNDRV_TIMER_IOCTL_STATUS _IOR('T', 0x14, struct snd_timer_status)
660 /* The following four ioctls are changed since 1.0.9 due to confliction */
661 #define SNDRV_TIMER_IOCTL_START _IO('T', 0xa0)
662 #define SNDRV_TIMER_IOCTL_STOP _IO('T', 0xa1)
663 #define SNDRV_TIMER_IOCTL_CONTINUE _IO('T', 0xa2)
664 #define SNDRV_TIMER_IOCTL_PAUSE _IO('T', 0xa3)
666 struct snd_timer_read {
667 unsigned int resolution;
668 unsigned int ticks;
671 enum {
672 SNDRV_TIMER_EVENT_RESOLUTION = 0, /* val = resolution in ns */
673 SNDRV_TIMER_EVENT_TICK, /* val = ticks */
674 SNDRV_TIMER_EVENT_START, /* val = resolution in ns */
675 SNDRV_TIMER_EVENT_STOP, /* val = 0 */
676 SNDRV_TIMER_EVENT_CONTINUE, /* val = resolution in ns */
677 SNDRV_TIMER_EVENT_PAUSE, /* val = 0 */
678 SNDRV_TIMER_EVENT_EARLY, /* val = 0, early event */
679 SNDRV_TIMER_EVENT_SUSPEND, /* val = 0 */
680 SNDRV_TIMER_EVENT_RESUME, /* val = resolution in ns */
681 /* master timer events for slave timer instances */
682 SNDRV_TIMER_EVENT_MSTART = SNDRV_TIMER_EVENT_START + 10,
683 SNDRV_TIMER_EVENT_MSTOP = SNDRV_TIMER_EVENT_STOP + 10,
684 SNDRV_TIMER_EVENT_MCONTINUE = SNDRV_TIMER_EVENT_CONTINUE + 10,
685 SNDRV_TIMER_EVENT_MPAUSE = SNDRV_TIMER_EVENT_PAUSE + 10,
686 SNDRV_TIMER_EVENT_MSUSPEND = SNDRV_TIMER_EVENT_SUSPEND + 10,
687 SNDRV_TIMER_EVENT_MRESUME = SNDRV_TIMER_EVENT_RESUME + 10,
690 struct snd_timer_tread {
691 int event;
692 struct timespec tstamp;
693 unsigned int val;
696 /****************************************************************************
698 * Section for driver control interface - /dev/snd/control? *
700 ****************************************************************************/
702 #define SNDRV_CTL_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 6)
704 struct snd_ctl_card_info {
705 int card; /* card number */
706 int pad; /* reserved for future (was type) */
707 unsigned char id[16]; /* ID of card (user selectable) */
708 unsigned char driver[16]; /* Driver name */
709 unsigned char name[32]; /* Short name of soundcard */
710 unsigned char longname[80]; /* name + info text about soundcard */
711 unsigned char reserved_[16]; /* reserved for future (was ID of mixer) */
712 unsigned char mixername[80]; /* visual mixer identification */
713 unsigned char components[128]; /* card components / fine identification, delimited with one space (AC97 etc..) */
716 typedef int __bitwise snd_ctl_elem_type_t;
717 #define SNDRV_CTL_ELEM_TYPE_NONE ((__force snd_ctl_elem_type_t) 0) /* invalid */
718 #define SNDRV_CTL_ELEM_TYPE_BOOLEAN ((__force snd_ctl_elem_type_t) 1) /* boolean type */
719 #define SNDRV_CTL_ELEM_TYPE_INTEGER ((__force snd_ctl_elem_type_t) 2) /* integer type */
720 #define SNDRV_CTL_ELEM_TYPE_ENUMERATED ((__force snd_ctl_elem_type_t) 3) /* enumerated type */
721 #define SNDRV_CTL_ELEM_TYPE_BYTES ((__force snd_ctl_elem_type_t) 4) /* byte array */
722 #define SNDRV_CTL_ELEM_TYPE_IEC958 ((__force snd_ctl_elem_type_t) 5) /* IEC958 (S/PDIF) setup */
723 #define SNDRV_CTL_ELEM_TYPE_INTEGER64 ((__force snd_ctl_elem_type_t) 6) /* 64-bit integer type */
724 #define SNDRV_CTL_ELEM_TYPE_LAST SNDRV_CTL_ELEM_TYPE_INTEGER64
726 typedef int __bitwise snd_ctl_elem_iface_t;
727 #define SNDRV_CTL_ELEM_IFACE_CARD ((__force snd_ctl_elem_iface_t) 0) /* global control */
728 #define SNDRV_CTL_ELEM_IFACE_HWDEP ((__force snd_ctl_elem_iface_t) 1) /* hardware dependent device */
729 #define SNDRV_CTL_ELEM_IFACE_MIXER ((__force snd_ctl_elem_iface_t) 2) /* virtual mixer device */
730 #define SNDRV_CTL_ELEM_IFACE_PCM ((__force snd_ctl_elem_iface_t) 3) /* PCM device */
731 #define SNDRV_CTL_ELEM_IFACE_RAWMIDI ((__force snd_ctl_elem_iface_t) 4) /* RawMidi device */
732 #define SNDRV_CTL_ELEM_IFACE_TIMER ((__force snd_ctl_elem_iface_t) 5) /* timer device */
733 #define SNDRV_CTL_ELEM_IFACE_SEQUENCER ((__force snd_ctl_elem_iface_t) 6) /* sequencer client */
734 #define SNDRV_CTL_ELEM_IFACE_LAST SNDRV_CTL_ELEM_IFACE_SEQUENCER
736 #define SNDRV_CTL_ELEM_ACCESS_READ (1<<0)
737 #define SNDRV_CTL_ELEM_ACCESS_WRITE (1<<1)
738 #define SNDRV_CTL_ELEM_ACCESS_READWRITE (SNDRV_CTL_ELEM_ACCESS_READ|SNDRV_CTL_ELEM_ACCESS_WRITE)
739 #define SNDRV_CTL_ELEM_ACCESS_VOLATILE (1<<2) /* control value may be changed without a notification */
740 #define SNDRV_CTL_ELEM_ACCESS_TIMESTAMP (1<<3) /* when was control changed */
741 #define SNDRV_CTL_ELEM_ACCESS_TLV_READ (1<<4) /* TLV read is possible */
742 #define SNDRV_CTL_ELEM_ACCESS_TLV_WRITE (1<<5) /* TLV write is possible */
743 #define SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE (SNDRV_CTL_ELEM_ACCESS_TLV_READ|SNDRV_CTL_ELEM_ACCESS_TLV_WRITE)
744 #define SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND (1<<6) /* TLV command is possible */
745 #define SNDRV_CTL_ELEM_ACCESS_INACTIVE (1<<8) /* control does actually nothing, but may be updated */
746 #define SNDRV_CTL_ELEM_ACCESS_LOCK (1<<9) /* write lock */
747 #define SNDRV_CTL_ELEM_ACCESS_OWNER (1<<10) /* write lock owner */
748 #define SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK (1<<28) /* kernel use a TLV callback */
749 #define SNDRV_CTL_ELEM_ACCESS_USER (1<<29) /* user space element */
750 /* bits 30 and 31 are obsoleted (for indirect access) */
752 /* for further details see the ACPI and PCI power management specification */
753 #define SNDRV_CTL_POWER_D0 0x0000 /* full On */
754 #define SNDRV_CTL_POWER_D1 0x0100 /* partial On */
755 #define SNDRV_CTL_POWER_D2 0x0200 /* partial On */
756 #define SNDRV_CTL_POWER_D3 0x0300 /* Off */
757 #define SNDRV_CTL_POWER_D3hot (SNDRV_CTL_POWER_D3|0x0000) /* Off, with power */
758 #define SNDRV_CTL_POWER_D3cold (SNDRV_CTL_POWER_D3|0x0001) /* Off, without power */
760 struct snd_ctl_elem_id {
761 unsigned int numid; /* numeric identifier, zero = invalid */
762 snd_ctl_elem_iface_t iface; /* interface identifier */
763 unsigned int device; /* device/client number */
764 unsigned int subdevice; /* subdevice (substream) number */
765 unsigned char name[44]; /* ASCII name of item */
766 unsigned int index; /* index of item */
769 struct snd_ctl_elem_list {
770 unsigned int offset; /* W: first element ID to get */
771 unsigned int space; /* W: count of element IDs to get */
772 unsigned int used; /* R: count of element IDs set */
773 unsigned int count; /* R: count of all elements */
774 struct snd_ctl_elem_id __user *pids; /* R: IDs */
775 unsigned char reserved[50];
778 struct snd_ctl_elem_info {
779 struct snd_ctl_elem_id id; /* W: element ID */
780 snd_ctl_elem_type_t type; /* R: value type - SNDRV_CTL_ELEM_TYPE_* */
781 unsigned int access; /* R: value access (bitmask) - SNDRV_CTL_ELEM_ACCESS_* */
782 unsigned int count; /* count of values */
783 __kernel_pid_t owner; /* owner's PID of this control */
784 union {
785 struct {
786 long min; /* R: minimum value */
787 long max; /* R: maximum value */
788 long step; /* R: step (0 variable) */
789 } integer;
790 struct {
791 long long min; /* R: minimum value */
792 long long max; /* R: maximum value */
793 long long step; /* R: step (0 variable) */
794 } integer64;
795 struct {
796 unsigned int items; /* R: number of items */
797 unsigned int item; /* W: item number */
798 char name[64]; /* R: value name */
799 } enumerated;
800 unsigned char reserved[128];
801 } value;
802 union {
803 unsigned short d[4]; /* dimensions */
804 unsigned short *d_ptr; /* indirect - obsoleted */
805 } dimen;
806 unsigned char reserved[64-4*sizeof(unsigned short)];
809 struct snd_ctl_elem_value {
810 struct snd_ctl_elem_id id; /* W: element ID */
811 unsigned int indirect: 1; /* W: indirect access - obsoleted */
812 union {
813 union {
814 long value[128];
815 long *value_ptr; /* obsoleted */
816 } integer;
817 union {
818 long long value[64];
819 long long *value_ptr; /* obsoleted */
820 } integer64;
821 union {
822 unsigned int item[128];
823 unsigned int *item_ptr; /* obsoleted */
824 } enumerated;
825 union {
826 unsigned char data[512];
827 unsigned char *data_ptr; /* obsoleted */
828 } bytes;
829 struct snd_aes_iec958 iec958;
830 } value; /* RO */
831 struct timespec tstamp;
832 unsigned char reserved[128-sizeof(struct timespec)];
835 struct snd_ctl_tlv {
836 unsigned int numid; /* control element numeric identification */
837 unsigned int length; /* in bytes aligned to 4 */
838 unsigned int tlv[0]; /* first TLV */
841 #define SNDRV_CTL_IOCTL_PVERSION _IOR('U', 0x00, int)
842 #define SNDRV_CTL_IOCTL_CARD_INFO _IOR('U', 0x01, struct snd_ctl_card_info)
843 #define SNDRV_CTL_IOCTL_ELEM_LIST _IOWR('U', 0x10, struct snd_ctl_elem_list)
844 #define SNDRV_CTL_IOCTL_ELEM_INFO _IOWR('U', 0x11, struct snd_ctl_elem_info)
845 #define SNDRV_CTL_IOCTL_ELEM_READ _IOWR('U', 0x12, struct snd_ctl_elem_value)
846 #define SNDRV_CTL_IOCTL_ELEM_WRITE _IOWR('U', 0x13, struct snd_ctl_elem_value)
847 #define SNDRV_CTL_IOCTL_ELEM_LOCK _IOW('U', 0x14, struct snd_ctl_elem_id)
848 #define SNDRV_CTL_IOCTL_ELEM_UNLOCK _IOW('U', 0x15, struct snd_ctl_elem_id)
849 #define SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS _IOWR('U', 0x16, int)
850 #define SNDRV_CTL_IOCTL_ELEM_ADD _IOWR('U', 0x17, struct snd_ctl_elem_info)
851 #define SNDRV_CTL_IOCTL_ELEM_REPLACE _IOWR('U', 0x18, struct snd_ctl_elem_info)
852 #define SNDRV_CTL_IOCTL_ELEM_REMOVE _IOWR('U', 0x19, struct snd_ctl_elem_id)
853 #define SNDRV_CTL_IOCTL_TLV_READ _IOWR('U', 0x1a, struct snd_ctl_tlv)
854 #define SNDRV_CTL_IOCTL_TLV_WRITE _IOWR('U', 0x1b, struct snd_ctl_tlv)
855 #define SNDRV_CTL_IOCTL_TLV_COMMAND _IOWR('U', 0x1c, struct snd_ctl_tlv)
856 #define SNDRV_CTL_IOCTL_HWDEP_NEXT_DEVICE _IOWR('U', 0x20, int)
857 #define SNDRV_CTL_IOCTL_HWDEP_INFO _IOR('U', 0x21, struct snd_hwdep_info)
858 #define SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE _IOR('U', 0x30, int)
859 #define SNDRV_CTL_IOCTL_PCM_INFO _IOWR('U', 0x31, struct snd_pcm_info)
860 #define SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE _IOW('U', 0x32, int)
861 #define SNDRV_CTL_IOCTL_RAWMIDI_NEXT_DEVICE _IOWR('U', 0x40, int)
862 #define SNDRV_CTL_IOCTL_RAWMIDI_INFO _IOWR('U', 0x41, struct snd_rawmidi_info)
863 #define SNDRV_CTL_IOCTL_RAWMIDI_PREFER_SUBDEVICE _IOW('U', 0x42, int)
864 #define SNDRV_CTL_IOCTL_POWER _IOWR('U', 0xd0, int)
865 #define SNDRV_CTL_IOCTL_POWER_STATE _IOR('U', 0xd1, int)
868 * Read interface.
871 enum sndrv_ctl_event_type {
872 SNDRV_CTL_EVENT_ELEM = 0,
873 SNDRV_CTL_EVENT_LAST = SNDRV_CTL_EVENT_ELEM,
876 #define SNDRV_CTL_EVENT_MASK_VALUE (1<<0) /* element value was changed */
877 #define SNDRV_CTL_EVENT_MASK_INFO (1<<1) /* element info was changed */
878 #define SNDRV_CTL_EVENT_MASK_ADD (1<<2) /* element was added */
879 #define SNDRV_CTL_EVENT_MASK_TLV (1<<3) /* element TLV tree was changed */
880 #define SNDRV_CTL_EVENT_MASK_REMOVE (~0U) /* element was removed */
882 struct snd_ctl_event {
883 int type; /* event type - SNDRV_CTL_EVENT_* */
884 union {
885 struct {
886 unsigned int mask;
887 struct snd_ctl_elem_id id;
888 } elem;
889 unsigned char data8[60];
890 } data;
894 * Control names
897 #define SNDRV_CTL_NAME_NONE ""
898 #define SNDRV_CTL_NAME_PLAYBACK "Playback "
899 #define SNDRV_CTL_NAME_CAPTURE "Capture "
901 #define SNDRV_CTL_NAME_IEC958_NONE ""
902 #define SNDRV_CTL_NAME_IEC958_SWITCH "Switch"
903 #define SNDRV_CTL_NAME_IEC958_VOLUME "Volume"
904 #define SNDRV_CTL_NAME_IEC958_DEFAULT "Default"
905 #define SNDRV_CTL_NAME_IEC958_MASK "Mask"
906 #define SNDRV_CTL_NAME_IEC958_CON_MASK "Con Mask"
907 #define SNDRV_CTL_NAME_IEC958_PRO_MASK "Pro Mask"
908 #define SNDRV_CTL_NAME_IEC958_PCM_STREAM "PCM Stream"
909 #define SNDRV_CTL_NAME_IEC958(expl,direction,what) "IEC958 " expl SNDRV_CTL_NAME_##direction SNDRV_CTL_NAME_IEC958_##what
911 #endif /* __SOUND_ASOUND_H */