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