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