[ALSA] Changed Jaroslav Kysela's e-mail from perex@suse.cz to perex@perex.cz
[linux-2.6.git] / include / sound / asound.h
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>
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 __SOUND_ASOUND_H
24 #define __SOUND_ASOUND_H
25
26 #ifdef __KERNEL__
27 #include <linux/ioctl.h>
28 #include <linux/types.h>
29 #include <linux/time.h>
30 #include <asm/byteorder.h>
31
32 #ifdef  __LITTLE_ENDIAN
33 #define SNDRV_LITTLE_ENDIAN
34 #else
35 #ifdef __BIG_ENDIAN
36 #define SNDRV_BIG_ENDIAN
37 #else
38 #error "Unsupported endian..."
39 #endif
40 #endif
41
42 #endif /* __KERNEL__ **/
43
44 /*
45  *  protocol version
46  */
47
48 #define SNDRV_PROTOCOL_VERSION(major, minor, subminor) (((major)<<16)|((minor)<<8)|(subminor))
49 #define SNDRV_PROTOCOL_MAJOR(version) (((version)>>16)&0xffff)
50 #define SNDRV_PROTOCOL_MINOR(version) (((version)>>8)&0xff)
51 #define SNDRV_PROTOCOL_MICRO(version) ((version)&0xff)
52 #define SNDRV_PROTOCOL_INCOMPATIBLE(kversion, uversion) \
53         (SNDRV_PROTOCOL_MAJOR(kversion) != SNDRV_PROTOCOL_MAJOR(uversion) || \
54          (SNDRV_PROTOCOL_MAJOR(kversion) == SNDRV_PROTOCOL_MAJOR(uversion) && \
55            SNDRV_PROTOCOL_MINOR(kversion) != SNDRV_PROTOCOL_MINOR(uversion)))
56
57 /****************************************************************************
58  *                                                                          *
59  *        Digital audio interface                                           *
60  *                                                                          *
61  ****************************************************************************/
62
63 struct snd_aes_iec958 {
64         unsigned char status[24];       /* AES/IEC958 channel status bits */
65         unsigned char subcode[147];     /* AES/IEC958 subcode bits */
66         unsigned char pad;              /* nothing */
67         unsigned char dig_subframe[4];  /* AES/IEC958 subframe bits */
68 };
69
70 /****************************************************************************
71  *                                                                          *
72  *      Section for driver hardware dependent interface - /dev/snd/hw?      *
73  *                                                                          *
74  ****************************************************************************/
75
76 #define SNDRV_HWDEP_VERSION             SNDRV_PROTOCOL_VERSION(1, 0, 1)
77
78 enum {
79         SNDRV_HWDEP_IFACE_OPL2 = 0,
80         SNDRV_HWDEP_IFACE_OPL3,
81         SNDRV_HWDEP_IFACE_OPL4,
82         SNDRV_HWDEP_IFACE_SB16CSP,      /* Creative Signal Processor */
83         SNDRV_HWDEP_IFACE_EMU10K1,      /* FX8010 processor in EMU10K1 chip */
84         SNDRV_HWDEP_IFACE_YSS225,       /* Yamaha FX processor */
85         SNDRV_HWDEP_IFACE_ICS2115,      /* Wavetable synth */
86         SNDRV_HWDEP_IFACE_SSCAPE,       /* Ensoniq SoundScape ISA card (MC68EC000) */
87         SNDRV_HWDEP_IFACE_VX,           /* Digigram VX cards */
88         SNDRV_HWDEP_IFACE_MIXART,       /* Digigram miXart cards */
89         SNDRV_HWDEP_IFACE_USX2Y,        /* Tascam US122, US224 & US428 usb */
90         SNDRV_HWDEP_IFACE_EMUX_WAVETABLE, /* EmuX wavetable */  
91         SNDRV_HWDEP_IFACE_BLUETOOTH,    /* Bluetooth audio */
92         SNDRV_HWDEP_IFACE_USX2Y_PCM,    /* Tascam US122, US224 & US428 rawusb pcm */
93         SNDRV_HWDEP_IFACE_PCXHR,        /* Digigram PCXHR */
94         SNDRV_HWDEP_IFACE_SB_RC,        /* SB Extigy/Audigy2NX remote control */
95         SNDRV_HWDEP_IFACE_HDA,          /* HD-audio */
96
97         /* Don't forget to change the following: */
98         SNDRV_HWDEP_IFACE_LAST = SNDRV_HWDEP_IFACE_SB_RC
99 };
100
101 struct 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 */
111 struct 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
120 struct 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 enum {
129         SNDRV_HWDEP_IOCTL_PVERSION = _IOR ('H', 0x00, int),
130         SNDRV_HWDEP_IOCTL_INFO = _IOR ('H', 0x01, struct snd_hwdep_info),
131         SNDRV_HWDEP_IOCTL_DSP_STATUS = _IOR('H', 0x02, struct snd_hwdep_dsp_status),
132         SNDRV_HWDEP_IOCTL_DSP_LOAD   = _IOW('H', 0x03, struct snd_hwdep_dsp_image)
133 };
134
135 /*****************************************************************************
136  *                                                                           *
137  *             Digital Audio (PCM) interface - /dev/snd/pcm??                *
138  *                                                                           *
139  *****************************************************************************/
140
141 #define SNDRV_PCM_VERSION               SNDRV_PROTOCOL_VERSION(2, 0, 8)
142
143 typedef unsigned long snd_pcm_uframes_t;
144 typedef signed long snd_pcm_sframes_t;
145
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,
153 };
154
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,
160 };
161
162 enum {
163         SNDRV_PCM_STREAM_PLAYBACK = 0,
164         SNDRV_PCM_STREAM_CAPTURE,
165         SNDRV_PCM_STREAM_LAST = SNDRV_PCM_STREAM_CAPTURE,
166 };
167
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
175
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
216
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
239
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
243
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
259 typedef int __bitwise snd_pcm_state_t;
260 #define SNDRV_PCM_STATE_OPEN            ((__force snd_pcm_state_t) 0) /* stream is open */
261 #define SNDRV_PCM_STATE_SETUP           ((__force snd_pcm_state_t) 1) /* stream has a setup */
262 #define SNDRV_PCM_STATE_PREPARED        ((__force snd_pcm_state_t) 2) /* stream is ready to start */
263 #define SNDRV_PCM_STATE_RUNNING         ((__force snd_pcm_state_t) 3) /* stream is running */
264 #define SNDRV_PCM_STATE_XRUN            ((__force snd_pcm_state_t) 4) /* stream reached an xrun */
265 #define SNDRV_PCM_STATE_DRAINING        ((__force snd_pcm_state_t) 5) /* stream is draining */
266 #define SNDRV_PCM_STATE_PAUSED          ((__force snd_pcm_state_t) 6) /* stream is paused */
267 #define SNDRV_PCM_STATE_SUSPENDED       ((__force snd_pcm_state_t) 7) /* hardware is suspended */
268 #define SNDRV_PCM_STATE_DISCONNECTED    ((__force snd_pcm_state_t) 8) /* hardware is disconnected */
269 #define SNDRV_PCM_STATE_LAST            SNDRV_PCM_STATE_DISCONNECTED
270
271 enum {
272         SNDRV_PCM_MMAP_OFFSET_DATA = 0x00000000,
273         SNDRV_PCM_MMAP_OFFSET_STATUS = 0x80000000,
274         SNDRV_PCM_MMAP_OFFSET_CONTROL = 0x81000000,
275 };
276
277 union snd_pcm_sync_id {
278         unsigned char id[16];
279         unsigned short id16[8];
280         unsigned int id32[4];
281 };
282
283 struct snd_pcm_info {
284         unsigned int device;            /* RO/WR (control): device number */
285         unsigned int subdevice;         /* RO/WR (control): subdevice number */
286         int stream;                     /* RO/WR (control): stream direction */
287         int card;                       /* R: card number */
288         unsigned char id[64];           /* ID (user selectable) */
289         unsigned char name[80];         /* name of this device */
290         unsigned char subname[32];      /* subdevice name */
291         int dev_class;                  /* SNDRV_PCM_CLASS_* */
292         int dev_subclass;               /* SNDRV_PCM_SUBCLASS_* */
293         unsigned int subdevices_count;
294         unsigned int subdevices_avail;
295         union snd_pcm_sync_id sync;     /* hardware synchronization ID */
296         unsigned char reserved[64];     /* reserved for future... */
297 };
298
299 typedef int __bitwise snd_pcm_hw_param_t;
300 #define SNDRV_PCM_HW_PARAM_ACCESS       ((__force snd_pcm_hw_param_t) 0) /* Access type */
301 #define SNDRV_PCM_HW_PARAM_FORMAT       ((__force snd_pcm_hw_param_t) 1) /* Format */
302 #define SNDRV_PCM_HW_PARAM_SUBFORMAT    ((__force snd_pcm_hw_param_t) 2) /* Subformat */
303 #define SNDRV_PCM_HW_PARAM_FIRST_MASK   SNDRV_PCM_HW_PARAM_ACCESS
304 #define SNDRV_PCM_HW_PARAM_LAST_MASK    SNDRV_PCM_HW_PARAM_SUBFORMAT
305
306 #define SNDRV_PCM_HW_PARAM_SAMPLE_BITS  ((__force snd_pcm_hw_param_t) 8) /* Bits per sample */
307 #define SNDRV_PCM_HW_PARAM_FRAME_BITS   ((__force snd_pcm_hw_param_t) 9) /* Bits per frame */
308 #define SNDRV_PCM_HW_PARAM_CHANNELS     ((__force snd_pcm_hw_param_t) 10) /* Channels */
309 #define SNDRV_PCM_HW_PARAM_RATE         ((__force snd_pcm_hw_param_t) 11) /* Approx rate */
310 #define SNDRV_PCM_HW_PARAM_PERIOD_TIME  ((__force snd_pcm_hw_param_t) 12) /* Approx distance between interrupts in us */
311 #define SNDRV_PCM_HW_PARAM_PERIOD_SIZE  ((__force snd_pcm_hw_param_t) 13) /* Approx frames between interrupts */
312 #define SNDRV_PCM_HW_PARAM_PERIOD_BYTES ((__force snd_pcm_hw_param_t) 14) /* Approx bytes between interrupts */
313 #define SNDRV_PCM_HW_PARAM_PERIODS      ((__force snd_pcm_hw_param_t) 15) /* Approx interrupts per buffer */
314 #define SNDRV_PCM_HW_PARAM_BUFFER_TIME  ((__force snd_pcm_hw_param_t) 16) /* Approx duration of buffer in us */
315 #define SNDRV_PCM_HW_PARAM_BUFFER_SIZE  ((__force snd_pcm_hw_param_t) 17) /* Size of buffer in frames */
316 #define SNDRV_PCM_HW_PARAM_BUFFER_BYTES ((__force snd_pcm_hw_param_t) 18) /* Size of buffer in bytes */
317 #define SNDRV_PCM_HW_PARAM_TICK_TIME    ((__force snd_pcm_hw_param_t) 19) /* Approx tick duration in us */
318 #define SNDRV_PCM_HW_PARAM_FIRST_INTERVAL       SNDRV_PCM_HW_PARAM_SAMPLE_BITS
319 #define SNDRV_PCM_HW_PARAM_LAST_INTERVAL        SNDRV_PCM_HW_PARAM_TICK_TIME
320
321 #define SNDRV_PCM_HW_PARAMS_NORESAMPLE          (1<<0)  /* avoid rate resampling */
322
323 struct snd_interval {
324         unsigned int min, max;
325         unsigned int openmin:1,
326                      openmax:1,
327                      integer:1,
328                      empty:1;
329 };
330
331 #define SNDRV_MASK_MAX  256
332
333 struct snd_mask {
334         u_int32_t bits[(SNDRV_MASK_MAX+31)/32];
335 };
336
337 struct snd_pcm_hw_params {
338         unsigned int flags;
339         struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK - 
340                                SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
341         struct snd_mask mres[5];        /* reserved masks */
342         struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
343                                         SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
344         struct snd_interval ires[9];    /* reserved intervals */
345         unsigned int rmask;             /* W: requested masks */
346         unsigned int cmask;             /* R: changed masks */
347         unsigned int info;              /* R: Info flags for returned setup */
348         unsigned int msbits;            /* R: used most significant bits */
349         unsigned int rate_num;          /* R: rate numerator */
350         unsigned int rate_den;          /* R: rate denominator */
351         snd_pcm_uframes_t fifo_size;    /* R: chip FIFO size in frames */
352         unsigned char reserved[64];     /* reserved for future */
353 };
354
355 enum {
356         SNDRV_PCM_TSTAMP_NONE = 0,
357         SNDRV_PCM_TSTAMP_MMAP,
358         SNDRV_PCM_TSTAMP_LAST = SNDRV_PCM_TSTAMP_MMAP,
359 };
360
361 struct snd_pcm_sw_params {
362         int tstamp_mode;                        /* timestamp mode */
363         unsigned int period_step;
364         unsigned int sleep_min;                 /* min ticks to sleep */
365         snd_pcm_uframes_t avail_min;            /* min avail frames for wakeup */
366         snd_pcm_uframes_t xfer_align;           /* xfer size need to be a multiple */
367         snd_pcm_uframes_t start_threshold;      /* min hw_avail frames for automatic start */
368         snd_pcm_uframes_t stop_threshold;       /* min avail frames for automatic stop */
369         snd_pcm_uframes_t silence_threshold;    /* min distance from noise for silence filling */
370         snd_pcm_uframes_t silence_size;         /* silence block size */
371         snd_pcm_uframes_t boundary;             /* pointers wrap point */
372         unsigned char reserved[64];             /* reserved for future */
373 };
374
375 struct snd_pcm_channel_info {
376         unsigned int channel;
377         off_t offset;                   /* mmap offset */
378         unsigned int first;             /* offset to first sample in bits */
379         unsigned int step;              /* samples distance in bits */
380 };
381
382 struct snd_pcm_status {
383         snd_pcm_state_t state;          /* stream state */
384         struct timespec trigger_tstamp; /* time when stream was started/stopped/paused */
385         struct timespec tstamp;         /* reference timestamp */
386         snd_pcm_uframes_t appl_ptr;     /* appl ptr */
387         snd_pcm_uframes_t hw_ptr;       /* hw ptr */
388         snd_pcm_sframes_t delay;        /* current delay in frames */
389         snd_pcm_uframes_t avail;        /* number of frames available */
390         snd_pcm_uframes_t avail_max;    /* max frames available on hw since last status */
391         snd_pcm_uframes_t overrange;    /* count of ADC (capture) overrange detections from last status */
392         snd_pcm_state_t suspended_state; /* suspended stream state */
393         unsigned char reserved[60];     /* must be filled with zero */
394 };
395
396 struct snd_pcm_mmap_status {
397         snd_pcm_state_t state;          /* RO: state - SNDRV_PCM_STATE_XXXX */
398         int pad1;                       /* Needed for 64 bit alignment */
399         snd_pcm_uframes_t hw_ptr;       /* RO: hw ptr (0...boundary-1) */
400         struct timespec tstamp;         /* Timestamp */
401         snd_pcm_state_t suspended_state; /* RO: suspended stream state */
402 };
403
404 struct snd_pcm_mmap_control {
405         snd_pcm_uframes_t appl_ptr;     /* RW: appl ptr (0...boundary-1) */
406         snd_pcm_uframes_t avail_min;    /* RW: min available frames for wakeup */
407 };
408
409 #define SNDRV_PCM_SYNC_PTR_HWSYNC       (1<<0)  /* execute hwsync */
410 #define SNDRV_PCM_SYNC_PTR_APPL         (1<<1)  /* get appl_ptr from driver (r/w op) */
411 #define SNDRV_PCM_SYNC_PTR_AVAIL_MIN    (1<<2)  /* get avail_min from driver */
412
413 struct snd_pcm_sync_ptr {
414         unsigned int flags;
415         union {
416                 struct snd_pcm_mmap_status status;
417                 unsigned char reserved[64];
418         } s;
419         union {
420                 struct snd_pcm_mmap_control control;
421                 unsigned char reserved[64];
422         } c;
423 };
424
425 struct snd_xferi {
426         snd_pcm_sframes_t result;
427         void __user *buf;
428         snd_pcm_uframes_t frames;
429 };
430
431 struct snd_xfern {
432         snd_pcm_sframes_t result;
433         void __user * __user *bufs;
434         snd_pcm_uframes_t frames;
435 };
436
437 enum {
438         SNDRV_PCM_IOCTL_PVERSION = _IOR('A', 0x00, int),
439         SNDRV_PCM_IOCTL_INFO = _IOR('A', 0x01, struct snd_pcm_info),
440         SNDRV_PCM_IOCTL_TSTAMP = _IOW('A', 0x02, int),
441         SNDRV_PCM_IOCTL_HW_REFINE = _IOWR('A', 0x10, struct snd_pcm_hw_params),
442         SNDRV_PCM_IOCTL_HW_PARAMS = _IOWR('A', 0x11, struct snd_pcm_hw_params),
443         SNDRV_PCM_IOCTL_HW_FREE = _IO('A', 0x12),
444         SNDRV_PCM_IOCTL_SW_PARAMS = _IOWR('A', 0x13, struct snd_pcm_sw_params),
445         SNDRV_PCM_IOCTL_STATUS = _IOR('A', 0x20, struct snd_pcm_status),
446         SNDRV_PCM_IOCTL_DELAY = _IOR('A', 0x21, snd_pcm_sframes_t),
447         SNDRV_PCM_IOCTL_HWSYNC = _IO('A', 0x22),
448         SNDRV_PCM_IOCTL_SYNC_PTR = _IOWR('A', 0x23, struct snd_pcm_sync_ptr),
449         SNDRV_PCM_IOCTL_CHANNEL_INFO = _IOR('A', 0x32, struct snd_pcm_channel_info),
450         SNDRV_PCM_IOCTL_PREPARE = _IO('A', 0x40),
451         SNDRV_PCM_IOCTL_RESET = _IO('A', 0x41),
452         SNDRV_PCM_IOCTL_START = _IO('A', 0x42),
453         SNDRV_PCM_IOCTL_DROP = _IO('A', 0x43),
454         SNDRV_PCM_IOCTL_DRAIN = _IO('A', 0x44),
455         SNDRV_PCM_IOCTL_PAUSE = _IOW('A', 0x45, int),
456         SNDRV_PCM_IOCTL_REWIND = _IOW('A', 0x46, snd_pcm_uframes_t),
457         SNDRV_PCM_IOCTL_RESUME = _IO('A', 0x47),
458         SNDRV_PCM_IOCTL_XRUN = _IO('A', 0x48),
459         SNDRV_PCM_IOCTL_FORWARD = _IOW('A', 0x49, snd_pcm_uframes_t),
460         SNDRV_PCM_IOCTL_WRITEI_FRAMES = _IOW('A', 0x50, struct snd_xferi),
461         SNDRV_PCM_IOCTL_READI_FRAMES = _IOR('A', 0x51, struct snd_xferi),
462         SNDRV_PCM_IOCTL_WRITEN_FRAMES = _IOW('A', 0x52, struct snd_xfern),
463         SNDRV_PCM_IOCTL_READN_FRAMES = _IOR('A', 0x53, struct snd_xfern),
464         SNDRV_PCM_IOCTL_LINK = _IOW('A', 0x60, int),
465         SNDRV_PCM_IOCTL_UNLINK = _IO('A', 0x61),
466 };
467
468 /* Trick to make alsa-lib/acinclude.m4 happy */
469 #define SNDRV_PCM_IOCTL_REWIND SNDRV_PCM_IOCTL_REWIND
470
471 /*****************************************************************************
472  *                                                                           *
473  *                            MIDI v1.0 interface                            *
474  *                                                                           *
475  *****************************************************************************/
476
477 /*
478  *  Raw MIDI section - /dev/snd/midi??
479  */
480
481 #define SNDRV_RAWMIDI_VERSION           SNDRV_PROTOCOL_VERSION(2, 0, 0)
482
483 enum {
484         SNDRV_RAWMIDI_STREAM_OUTPUT = 0,
485         SNDRV_RAWMIDI_STREAM_INPUT,
486         SNDRV_RAWMIDI_STREAM_LAST = SNDRV_RAWMIDI_STREAM_INPUT,
487 };
488
489 #define SNDRV_RAWMIDI_INFO_OUTPUT               0x00000001
490 #define SNDRV_RAWMIDI_INFO_INPUT                0x00000002
491 #define SNDRV_RAWMIDI_INFO_DUPLEX               0x00000004
492
493 struct snd_rawmidi_info {
494         unsigned int device;            /* RO/WR (control): device number */
495         unsigned int subdevice;         /* RO/WR (control): subdevice number */
496         int stream;                     /* WR: stream */
497         int card;                       /* R: card number */
498         unsigned int flags;             /* SNDRV_RAWMIDI_INFO_XXXX */
499         unsigned char id[64];           /* ID (user selectable) */
500         unsigned char name[80];         /* name of device */
501         unsigned char subname[32];      /* name of active or selected subdevice */
502         unsigned int subdevices_count;
503         unsigned int subdevices_avail;
504         unsigned char reserved[64];     /* reserved for future use */
505 };
506
507 struct snd_rawmidi_params {
508         int stream;
509         size_t buffer_size;             /* queue size in bytes */
510         size_t avail_min;               /* minimum avail bytes for wakeup */
511         unsigned int no_active_sensing: 1; /* do not send active sensing byte in close() */
512         unsigned char reserved[16];     /* reserved for future use */
513 };
514
515 struct snd_rawmidi_status {
516         int stream;
517         struct timespec tstamp;         /* Timestamp */
518         size_t avail;                   /* available bytes */
519         size_t xruns;                   /* count of overruns since last status (in bytes) */
520         unsigned char reserved[16];     /* reserved for future use */
521 };
522
523 enum {
524         SNDRV_RAWMIDI_IOCTL_PVERSION = _IOR('W', 0x00, int),
525         SNDRV_RAWMIDI_IOCTL_INFO = _IOR('W', 0x01, struct snd_rawmidi_info),
526         SNDRV_RAWMIDI_IOCTL_PARAMS = _IOWR('W', 0x10, struct snd_rawmidi_params),
527         SNDRV_RAWMIDI_IOCTL_STATUS = _IOWR('W', 0x20, struct snd_rawmidi_status),
528         SNDRV_RAWMIDI_IOCTL_DROP = _IOW('W', 0x30, int),
529         SNDRV_RAWMIDI_IOCTL_DRAIN = _IOW('W', 0x31, int),
530 };
531
532 /*
533  *  Timer section - /dev/snd/timer
534  */
535
536 #define SNDRV_TIMER_VERSION             SNDRV_PROTOCOL_VERSION(2, 0, 5)
537
538 enum {
539         SNDRV_TIMER_CLASS_NONE = -1,
540         SNDRV_TIMER_CLASS_SLAVE = 0,
541         SNDRV_TIMER_CLASS_GLOBAL,
542         SNDRV_TIMER_CLASS_CARD,
543         SNDRV_TIMER_CLASS_PCM,
544         SNDRV_TIMER_CLASS_LAST = SNDRV_TIMER_CLASS_PCM,
545 };
546
547 /* slave timer classes */
548 enum {
549         SNDRV_TIMER_SCLASS_NONE = 0,
550         SNDRV_TIMER_SCLASS_APPLICATION,
551         SNDRV_TIMER_SCLASS_SEQUENCER,           /* alias */
552         SNDRV_TIMER_SCLASS_OSS_SEQUENCER,       /* alias */
553         SNDRV_TIMER_SCLASS_LAST = SNDRV_TIMER_SCLASS_OSS_SEQUENCER,
554 };
555
556 /* global timers (device member) */
557 #define SNDRV_TIMER_GLOBAL_SYSTEM       0
558 #define SNDRV_TIMER_GLOBAL_RTC          1
559 #define SNDRV_TIMER_GLOBAL_HPET         2
560
561 /* info flags */
562 #define SNDRV_TIMER_FLG_SLAVE           (1<<0)  /* cannot be controlled */
563
564 struct snd_timer_id {
565         int dev_class;  
566         int dev_sclass;
567         int card;
568         int device;
569         int subdevice;
570 };
571
572 struct snd_timer_ginfo {
573         struct snd_timer_id tid;        /* requested timer ID */
574         unsigned int flags;             /* timer flags - SNDRV_TIMER_FLG_* */
575         int card;                       /* card number */
576         unsigned char id[64];           /* timer identification */
577         unsigned char name[80];         /* timer name */
578         unsigned long reserved0;        /* reserved for future use */
579         unsigned long resolution;       /* average period resolution in ns */
580         unsigned long resolution_min;   /* minimal period resolution in ns */
581         unsigned long resolution_max;   /* maximal period resolution in ns */
582         unsigned int clients;           /* active timer clients */
583         unsigned char reserved[32];
584 };
585
586 struct snd_timer_gparams {
587         struct snd_timer_id tid;        /* requested timer ID */
588         unsigned long period_num;       /* requested precise period duration (in seconds) - numerator */
589         unsigned long period_den;       /* requested precise period duration (in seconds) - denominator */
590         unsigned char reserved[32];
591 };
592
593 struct snd_timer_gstatus {
594         struct snd_timer_id tid;        /* requested timer ID */
595         unsigned long resolution;       /* current period resolution in ns */
596         unsigned long resolution_num;   /* precise current period resolution (in seconds) - numerator */
597         unsigned long resolution_den;   /* precise current period resolution (in seconds) - denominator */
598         unsigned char reserved[32];
599 };
600
601 struct snd_timer_select {
602         struct snd_timer_id id; /* bind to timer ID */
603         unsigned char reserved[32];     /* reserved */
604 };
605
606 struct snd_timer_info {
607         unsigned int flags;             /* timer flags - SNDRV_TIMER_FLG_* */
608         int card;                       /* card number */
609         unsigned char id[64];           /* timer identificator */
610         unsigned char name[80];         /* timer name */
611         unsigned long reserved0;        /* reserved for future use */
612         unsigned long resolution;       /* average period resolution in ns */
613         unsigned char reserved[64];     /* reserved */
614 };
615
616 #define SNDRV_TIMER_PSFLG_AUTO          (1<<0)  /* auto start, otherwise one-shot */
617 #define SNDRV_TIMER_PSFLG_EXCLUSIVE     (1<<1)  /* exclusive use, precise start/stop/pause/continue */
618 #define SNDRV_TIMER_PSFLG_EARLY_EVENT   (1<<2)  /* write early event to the poll queue */
619
620 struct snd_timer_params {
621         unsigned int flags;             /* flags - SNDRV_MIXER_PSFLG_* */
622         unsigned int ticks;             /* requested resolution in ticks */
623         unsigned int queue_size;        /* total size of queue (32-1024) */
624         unsigned int reserved0;         /* reserved, was: failure locations */
625         unsigned int filter;            /* event filter (bitmask of SNDRV_TIMER_EVENT_*) */
626         unsigned char reserved[60];     /* reserved */
627 };
628
629 struct snd_timer_status {
630         struct timespec tstamp;         /* Timestamp - last update */
631         unsigned int resolution;        /* current period resolution in ns */
632         unsigned int lost;              /* counter of master tick lost */
633         unsigned int overrun;           /* count of read queue overruns */
634         unsigned int queue;             /* used queue size */
635         unsigned char reserved[64];     /* reserved */
636 };
637
638 enum {
639         SNDRV_TIMER_IOCTL_PVERSION = _IOR('T', 0x00, int),
640         SNDRV_TIMER_IOCTL_NEXT_DEVICE = _IOWR('T', 0x01, struct snd_timer_id),
641         SNDRV_TIMER_IOCTL_TREAD = _IOW('T', 0x02, int),
642         SNDRV_TIMER_IOCTL_GINFO = _IOWR('T', 0x03, struct snd_timer_ginfo),
643         SNDRV_TIMER_IOCTL_GPARAMS = _IOW('T', 0x04, struct snd_timer_gparams),
644         SNDRV_TIMER_IOCTL_GSTATUS = _IOWR('T', 0x05, struct snd_timer_gstatus),
645         SNDRV_TIMER_IOCTL_SELECT = _IOW('T', 0x10, struct snd_timer_select),
646         SNDRV_TIMER_IOCTL_INFO = _IOR('T', 0x11, struct snd_timer_info),
647         SNDRV_TIMER_IOCTL_PARAMS = _IOW('T', 0x12, struct snd_timer_params),
648         SNDRV_TIMER_IOCTL_STATUS = _IOR('T', 0x14, struct snd_timer_status),
649         /* The following four ioctls are changed since 1.0.9 due to confliction */
650         SNDRV_TIMER_IOCTL_START = _IO('T', 0xa0),
651         SNDRV_TIMER_IOCTL_STOP = _IO('T', 0xa1),
652         SNDRV_TIMER_IOCTL_CONTINUE = _IO('T', 0xa2),
653         SNDRV_TIMER_IOCTL_PAUSE = _IO('T', 0xa3),
654 };
655
656 struct snd_timer_read {
657         unsigned int resolution;
658         unsigned int ticks;
659 };
660
661 enum {
662         SNDRV_TIMER_EVENT_RESOLUTION = 0,       /* val = resolution in ns */
663         SNDRV_TIMER_EVENT_TICK,                 /* val = ticks */
664         SNDRV_TIMER_EVENT_START,                /* val = resolution in ns */
665         SNDRV_TIMER_EVENT_STOP,                 /* val = 0 */
666         SNDRV_TIMER_EVENT_CONTINUE,             /* val = resolution in ns */
667         SNDRV_TIMER_EVENT_PAUSE,                /* val = 0 */
668         SNDRV_TIMER_EVENT_EARLY,                /* val = 0, early event */
669         SNDRV_TIMER_EVENT_SUSPEND,              /* val = 0 */
670         SNDRV_TIMER_EVENT_RESUME,               /* val = resolution in ns */
671         /* master timer events for slave timer instances */
672         SNDRV_TIMER_EVENT_MSTART = SNDRV_TIMER_EVENT_START + 10,
673         SNDRV_TIMER_EVENT_MSTOP = SNDRV_TIMER_EVENT_STOP + 10,
674         SNDRV_TIMER_EVENT_MCONTINUE = SNDRV_TIMER_EVENT_CONTINUE + 10,
675         SNDRV_TIMER_EVENT_MPAUSE = SNDRV_TIMER_EVENT_PAUSE + 10,
676         SNDRV_TIMER_EVENT_MSUSPEND = SNDRV_TIMER_EVENT_SUSPEND + 10,
677         SNDRV_TIMER_EVENT_MRESUME = SNDRV_TIMER_EVENT_RESUME + 10,
678 };
679
680 struct snd_timer_tread {
681         int event;
682         struct timespec tstamp;
683         unsigned int val;
684 };
685
686 /****************************************************************************
687  *                                                                          *
688  *        Section for driver control interface - /dev/snd/control?          *
689  *                                                                          *
690  ****************************************************************************/
691
692 #define SNDRV_CTL_VERSION               SNDRV_PROTOCOL_VERSION(2, 0, 4)
693
694 struct snd_ctl_card_info {
695         int card;                       /* card number */
696         int pad;                        /* reserved for future (was type) */
697         unsigned char id[16];           /* ID of card (user selectable) */
698         unsigned char driver[16];       /* Driver name */
699         unsigned char name[32];         /* Short name of soundcard */
700         unsigned char longname[80];     /* name + info text about soundcard */
701         unsigned char reserved_[16];    /* reserved for future (was ID of mixer) */
702         unsigned char mixername[80];    /* visual mixer identification */
703         unsigned char components[80];   /* card components / fine identification, delimited with one space (AC97 etc..) */
704         unsigned char reserved[48];     /* reserved for future */
705 };
706
707 typedef int __bitwise snd_ctl_elem_type_t;
708 #define SNDRV_CTL_ELEM_TYPE_NONE        ((__force snd_ctl_elem_type_t) 0) /* invalid */
709 #define SNDRV_CTL_ELEM_TYPE_BOOLEAN     ((__force snd_ctl_elem_type_t) 1) /* boolean type */
710 #define SNDRV_CTL_ELEM_TYPE_INTEGER     ((__force snd_ctl_elem_type_t) 2) /* integer type */
711 #define SNDRV_CTL_ELEM_TYPE_ENUMERATED  ((__force snd_ctl_elem_type_t) 3) /* enumerated type */
712 #define SNDRV_CTL_ELEM_TYPE_BYTES       ((__force snd_ctl_elem_type_t) 4) /* byte array */
713 #define SNDRV_CTL_ELEM_TYPE_IEC958      ((__force snd_ctl_elem_type_t) 5) /* IEC958 (S/PDIF) setup */
714 #define SNDRV_CTL_ELEM_TYPE_INTEGER64   ((__force snd_ctl_elem_type_t) 6) /* 64-bit integer type */
715 #define SNDRV_CTL_ELEM_TYPE_LAST        SNDRV_CTL_ELEM_TYPE_INTEGER64
716
717 typedef int __bitwise snd_ctl_elem_iface_t;
718 #define SNDRV_CTL_ELEM_IFACE_CARD       ((__force snd_ctl_elem_iface_t) 0) /* global control */
719 #define SNDRV_CTL_ELEM_IFACE_HWDEP      ((__force snd_ctl_elem_iface_t) 1) /* hardware dependent device */
720 #define SNDRV_CTL_ELEM_IFACE_MIXER      ((__force snd_ctl_elem_iface_t) 2) /* virtual mixer device */
721 #define SNDRV_CTL_ELEM_IFACE_PCM        ((__force snd_ctl_elem_iface_t) 3) /* PCM device */
722 #define SNDRV_CTL_ELEM_IFACE_RAWMIDI    ((__force snd_ctl_elem_iface_t) 4) /* RawMidi device */
723 #define SNDRV_CTL_ELEM_IFACE_TIMER      ((__force snd_ctl_elem_iface_t) 5) /* timer device */
724 #define SNDRV_CTL_ELEM_IFACE_SEQUENCER  ((__force snd_ctl_elem_iface_t) 6) /* sequencer client */
725 #define SNDRV_CTL_ELEM_IFACE_LAST       SNDRV_CTL_ELEM_IFACE_SEQUENCER
726
727 #define SNDRV_CTL_ELEM_ACCESS_READ              (1<<0)
728 #define SNDRV_CTL_ELEM_ACCESS_WRITE             (1<<1)
729 #define SNDRV_CTL_ELEM_ACCESS_READWRITE         (SNDRV_CTL_ELEM_ACCESS_READ|SNDRV_CTL_ELEM_ACCESS_WRITE)
730 #define SNDRV_CTL_ELEM_ACCESS_VOLATILE          (1<<2)  /* control value may be changed without a notification */
731 #define SNDRV_CTL_ELEM_ACCESS_TIMESTAMP         (1<<3)  /* when was control changed */
732 #define SNDRV_CTL_ELEM_ACCESS_TLV_READ          (1<<4)  /* TLV read is possible */
733 #define SNDRV_CTL_ELEM_ACCESS_TLV_WRITE         (1<<5)  /* TLV write is possible */
734 #define SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE     (SNDRV_CTL_ELEM_ACCESS_TLV_READ|SNDRV_CTL_ELEM_ACCESS_TLV_WRITE)
735 #define SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND       (1<<6)  /* TLV command is possible */
736 #define SNDRV_CTL_ELEM_ACCESS_INACTIVE          (1<<8)  /* control does actually nothing, but may be updated */
737 #define SNDRV_CTL_ELEM_ACCESS_LOCK              (1<<9)  /* write lock */
738 #define SNDRV_CTL_ELEM_ACCESS_OWNER             (1<<10) /* write lock owner */
739 #define SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK      (1<<28) /* kernel use a TLV callback */ 
740 #define SNDRV_CTL_ELEM_ACCESS_USER              (1<<29) /* user space element */
741 #define SNDRV_CTL_ELEM_ACCESS_DINDIRECT         (1<<30) /* indirect access for matrix dimensions in the info structure */
742 #define SNDRV_CTL_ELEM_ACCESS_INDIRECT          (1<<31) /* indirect access for element value in the value structure */
743
744 /* for further details see the ACPI and PCI power management specification */
745 #define SNDRV_CTL_POWER_D0              0x0000  /* full On */
746 #define SNDRV_CTL_POWER_D1              0x0100  /* partial On */
747 #define SNDRV_CTL_POWER_D2              0x0200  /* partial On */
748 #define SNDRV_CTL_POWER_D3              0x0300  /* Off */
749 #define SNDRV_CTL_POWER_D3hot           (SNDRV_CTL_POWER_D3|0x0000)     /* Off, with power */
750 #define SNDRV_CTL_POWER_D3cold          (SNDRV_CTL_POWER_D3|0x0001)     /* Off, without power */
751
752 struct snd_ctl_elem_id {
753         unsigned int numid;             /* numeric identifier, zero = invalid */
754         snd_ctl_elem_iface_t iface;     /* interface identifier */
755         unsigned int device;            /* device/client number */
756         unsigned int subdevice;         /* subdevice (substream) number */
757         unsigned char name[44];         /* ASCII name of item */
758         unsigned int index;             /* index of item */
759 };
760
761 struct snd_ctl_elem_list {
762         unsigned int offset;            /* W: first element ID to get */
763         unsigned int space;             /* W: count of element IDs to get */
764         unsigned int used;              /* R: count of element IDs set */
765         unsigned int count;             /* R: count of all elements */
766         struct snd_ctl_elem_id __user *pids; /* R: IDs */
767         unsigned char reserved[50];
768 };
769
770 struct snd_ctl_elem_info {
771         struct snd_ctl_elem_id id;      /* W: element ID */
772         snd_ctl_elem_type_t type;       /* R: value type - SNDRV_CTL_ELEM_TYPE_* */
773         unsigned int access;            /* R: value access (bitmask) - SNDRV_CTL_ELEM_ACCESS_* */
774         unsigned int count;             /* count of values */
775         pid_t owner;                    /* owner's PID of this control */
776         union {
777                 struct {
778                         long min;               /* R: minimum value */
779                         long max;               /* R: maximum value */
780                         long step;              /* R: step (0 variable) */
781                 } integer;
782                 struct {
783                         long long min;          /* R: minimum value */
784                         long long max;          /* R: maximum value */
785                         long long step;         /* R: step (0 variable) */
786                 } integer64;
787                 struct {
788                         unsigned int items;     /* R: number of items */
789                         unsigned int item;      /* W: item number */
790                         char name[64];          /* R: value name */
791                 } enumerated;
792                 unsigned char reserved[128];
793         } value;
794         union {
795                 unsigned short d[4];            /* dimensions */
796                 unsigned short *d_ptr;          /* indirect */
797         } dimen;
798         unsigned char reserved[64-4*sizeof(unsigned short)];
799 };
800
801 struct snd_ctl_elem_value {
802         struct snd_ctl_elem_id id;      /* W: element ID */
803         unsigned int indirect: 1;       /* W: use indirect pointer (xxx_ptr member) */
804         union {
805                 union {
806                         long value[128];
807                         long *value_ptr;
808                 } integer;
809                 union {
810                         long long value[64];
811                         long long *value_ptr;
812                 } integer64;
813                 union {
814                         unsigned int item[128];
815                         unsigned int *item_ptr;
816                 } enumerated;
817                 union {
818                         unsigned char data[512];
819                         unsigned char *data_ptr;
820                 } bytes;
821                 struct snd_aes_iec958 iec958;
822         } value;                /* RO */
823         struct timespec tstamp;
824         unsigned char reserved[128-sizeof(struct timespec)];
825 };
826
827 struct snd_ctl_tlv {
828         unsigned int numid;     /* control element numeric identification */
829         unsigned int length;    /* in bytes aligned to 4 */
830         unsigned int tlv[0];    /* first TLV */
831 };
832
833 enum {
834         SNDRV_CTL_IOCTL_PVERSION = _IOR('U', 0x00, int),
835         SNDRV_CTL_IOCTL_CARD_INFO = _IOR('U', 0x01, struct snd_ctl_card_info),
836         SNDRV_CTL_IOCTL_ELEM_LIST = _IOWR('U', 0x10, struct snd_ctl_elem_list),
837         SNDRV_CTL_IOCTL_ELEM_INFO = _IOWR('U', 0x11, struct snd_ctl_elem_info),
838         SNDRV_CTL_IOCTL_ELEM_READ = _IOWR('U', 0x12, struct snd_ctl_elem_value),
839         SNDRV_CTL_IOCTL_ELEM_WRITE = _IOWR('U', 0x13, struct snd_ctl_elem_value),
840         SNDRV_CTL_IOCTL_ELEM_LOCK = _IOW('U', 0x14, struct snd_ctl_elem_id),
841         SNDRV_CTL_IOCTL_ELEM_UNLOCK = _IOW('U', 0x15, struct snd_ctl_elem_id),
842         SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS = _IOWR('U', 0x16, int),
843         SNDRV_CTL_IOCTL_ELEM_ADD = _IOWR('U', 0x17, struct snd_ctl_elem_info),
844         SNDRV_CTL_IOCTL_ELEM_REPLACE = _IOWR('U', 0x18, struct snd_ctl_elem_info),
845         SNDRV_CTL_IOCTL_ELEM_REMOVE = _IOWR('U', 0x19, struct snd_ctl_elem_id),
846         SNDRV_CTL_IOCTL_TLV_READ = _IOWR('U', 0x1a, struct snd_ctl_tlv),
847         SNDRV_CTL_IOCTL_TLV_WRITE = _IOWR('U', 0x1b, struct snd_ctl_tlv),
848         SNDRV_CTL_IOCTL_TLV_COMMAND = _IOWR('U', 0x1c, struct snd_ctl_tlv),
849         SNDRV_CTL_IOCTL_HWDEP_NEXT_DEVICE = _IOWR('U', 0x20, int),
850         SNDRV_CTL_IOCTL_HWDEP_INFO = _IOR('U', 0x21, struct snd_hwdep_info),
851         SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE = _IOR('U', 0x30, int),
852         SNDRV_CTL_IOCTL_PCM_INFO = _IOWR('U', 0x31, struct snd_pcm_info),
853         SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE = _IOW('U', 0x32, int),
854         SNDRV_CTL_IOCTL_RAWMIDI_NEXT_DEVICE = _IOWR('U', 0x40, int),
855         SNDRV_CTL_IOCTL_RAWMIDI_INFO = _IOWR('U', 0x41, struct snd_rawmidi_info),
856         SNDRV_CTL_IOCTL_RAWMIDI_PREFER_SUBDEVICE = _IOW('U', 0x42, int),
857         SNDRV_CTL_IOCTL_POWER = _IOWR('U', 0xd0, int),
858         SNDRV_CTL_IOCTL_POWER_STATE = _IOR('U', 0xd1, int),
859 };
860
861 /*
862  *  Read interface.
863  */
864
865 enum sndrv_ctl_event_type {
866         SNDRV_CTL_EVENT_ELEM = 0,
867         SNDRV_CTL_EVENT_LAST = SNDRV_CTL_EVENT_ELEM,
868 };
869
870 #define SNDRV_CTL_EVENT_MASK_VALUE      (1<<0)  /* element value was changed */
871 #define SNDRV_CTL_EVENT_MASK_INFO       (1<<1)  /* element info was changed */
872 #define SNDRV_CTL_EVENT_MASK_ADD        (1<<2)  /* element was added */
873 #define SNDRV_CTL_EVENT_MASK_TLV        (1<<3)  /* element TLV tree was changed */
874 #define SNDRV_CTL_EVENT_MASK_REMOVE     (~0U)   /* element was removed */
875
876 struct snd_ctl_event {
877         int type;       /* event type - SNDRV_CTL_EVENT_* */
878         union {
879                 struct {
880                         unsigned int mask;
881                         struct snd_ctl_elem_id id;
882                 } elem;
883                 unsigned char data8[60];
884         } data;
885 };
886
887 /*
888  *  Control names
889  */
890
891 #define SNDRV_CTL_NAME_NONE                             ""
892 #define SNDRV_CTL_NAME_PLAYBACK                         "Playback "
893 #define SNDRV_CTL_NAME_CAPTURE                          "Capture "
894
895 #define SNDRV_CTL_NAME_IEC958_NONE                      ""
896 #define SNDRV_CTL_NAME_IEC958_SWITCH                    "Switch"
897 #define SNDRV_CTL_NAME_IEC958_VOLUME                    "Volume"
898 #define SNDRV_CTL_NAME_IEC958_DEFAULT                   "Default"
899 #define SNDRV_CTL_NAME_IEC958_MASK                      "Mask"
900 #define SNDRV_CTL_NAME_IEC958_CON_MASK                  "Con Mask"
901 #define SNDRV_CTL_NAME_IEC958_PRO_MASK                  "Pro Mask"
902 #define SNDRV_CTL_NAME_IEC958_PCM_STREAM                "PCM Stream"
903 #define SNDRV_CTL_NAME_IEC958(expl,direction,what)      "IEC958 " expl SNDRV_CTL_NAME_##direction SNDRV_CTL_NAME_IEC958_##what
904
905 /*
906  *
907  */
908
909 struct snd_xferv {
910         const struct iovec *vector;
911         unsigned long count;
912 };
913
914 enum {
915         SNDRV_IOCTL_READV = _IOW('K', 0x00, struct snd_xferv),
916         SNDRV_IOCTL_WRITEV = _IOW('K', 0x01, struct snd_xferv),
917 };
918
919 #endif /* __SOUND_ASOUND_H */