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