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