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