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