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