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