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

source code of include/sound/asound.h