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