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