WIP FPC-III support
[linux/fpc-iii.git] / tools / include / uapi / sound / asound.h
blob535a7229e1d94a706dd8f91d9fdfdf0e0f66caa4
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>
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.
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.
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
24 #ifndef _UAPI__SOUND_ASOUND_H
25 #define _UAPI__SOUND_ASOUND_H
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
35 #ifndef __KERNEL__
36 #include <stdlib.h>
37 #include <time.h>
38 #endif
41 * protocol version
44 #define SNDRV_PROTOCOL_VERSION(major, minor, subminor) (((major)<<16)|((minor)<<8)|(subminor))
45 #define SNDRV_PROTOCOL_MAJOR(version) (((version)>>16)&0xffff)
46 #define SNDRV_PROTOCOL_MINOR(version) (((version)>>8)&0xff)
47 #define SNDRV_PROTOCOL_MICRO(version) ((version)&0xff)
48 #define SNDRV_PROTOCOL_INCOMPATIBLE(kversion, uversion) \
49 (SNDRV_PROTOCOL_MAJOR(kversion) != SNDRV_PROTOCOL_MAJOR(uversion) || \
50 (SNDRV_PROTOCOL_MAJOR(kversion) == SNDRV_PROTOCOL_MAJOR(uversion) && \
51 SNDRV_PROTOCOL_MINOR(kversion) != SNDRV_PROTOCOL_MINOR(uversion)))
53 /****************************************************************************
54 * *
55 * Digital audio interface *
56 * *
57 ****************************************************************************/
59 struct snd_aes_iec958 {
60 unsigned char status[24]; /* 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 */
66 /****************************************************************************
67 * *
68 * CEA-861 Audio InfoFrame. Used in HDMI and DisplayPort *
69 * *
70 ****************************************************************************/
72 struct 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 */
80 /****************************************************************************
81 * *
82 * Section for driver hardware dependent interface - /dev/snd/hw? *
83 * *
84 ****************************************************************************/
86 #define SNDRV_HWDEP_VERSION SNDRV_PROTOCOL_VERSION(1, 0, 1)
88 enum {
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 */
117 /* Don't forget to change the following: */
118 SNDRV_HWDEP_IFACE_LAST = SNDRV_HWDEP_IFACE_FW_FIREFACE
121 struct 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 */
130 /* generic DSP loader */
131 struct 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 */
140 struct 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 __user *image; /* W: binary image */
144 size_t length; /* W: size of image in bytes */
145 unsigned long driver_data; /* W: driver-specific data */
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)
153 /*****************************************************************************
155 * Digital Audio (PCM) interface - /dev/snd/pcm?? *
157 *****************************************************************************/
159 #define SNDRV_PCM_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 15)
161 typedef unsigned long snd_pcm_uframes_t;
162 typedef signed long snd_pcm_sframes_t;
164 enum {
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,
173 enum {
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,
180 enum {
181 SNDRV_PCM_STREAM_PLAYBACK = 0,
182 SNDRV_PCM_STREAM_CAPTURE,
183 SNDRV_PCM_STREAM_LAST = SNDRV_PCM_STREAM_CAPTURE,
186 typedef int __bitwise snd_pcm_access_t;
187 #define SNDRV_PCM_ACCESS_MMAP_INTERLEAVED ((__force snd_pcm_access_t) 0) /* interleaved mmap */
188 #define SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED ((__force snd_pcm_access_t) 1) /* noninterleaved mmap */
189 #define SNDRV_PCM_ACCESS_MMAP_COMPLEX ((__force snd_pcm_access_t) 2) /* complex mmap */
190 #define SNDRV_PCM_ACCESS_RW_INTERLEAVED ((__force snd_pcm_access_t) 3) /* readi/writei */
191 #define SNDRV_PCM_ACCESS_RW_NONINTERLEAVED ((__force snd_pcm_access_t) 4) /* readn/writen */
192 #define SNDRV_PCM_ACCESS_LAST SNDRV_PCM_ACCESS_RW_NONINTERLEAVED
194 typedef int __bitwise snd_pcm_format_t;
195 #define SNDRV_PCM_FORMAT_S8 ((__force snd_pcm_format_t) 0)
196 #define SNDRV_PCM_FORMAT_U8 ((__force snd_pcm_format_t) 1)
197 #define SNDRV_PCM_FORMAT_S16_LE ((__force snd_pcm_format_t) 2)
198 #define SNDRV_PCM_FORMAT_S16_BE ((__force snd_pcm_format_t) 3)
199 #define SNDRV_PCM_FORMAT_U16_LE ((__force snd_pcm_format_t) 4)
200 #define SNDRV_PCM_FORMAT_U16_BE ((__force snd_pcm_format_t) 5)
201 #define SNDRV_PCM_FORMAT_S24_LE ((__force snd_pcm_format_t) 6) /* low three bytes */
202 #define SNDRV_PCM_FORMAT_S24_BE ((__force snd_pcm_format_t) 7) /* low three bytes */
203 #define SNDRV_PCM_FORMAT_U24_LE ((__force snd_pcm_format_t) 8) /* low three bytes */
204 #define SNDRV_PCM_FORMAT_U24_BE ((__force snd_pcm_format_t) 9) /* low three bytes */
205 #define SNDRV_PCM_FORMAT_S32_LE ((__force snd_pcm_format_t) 10)
206 #define SNDRV_PCM_FORMAT_S32_BE ((__force snd_pcm_format_t) 11)
207 #define SNDRV_PCM_FORMAT_U32_LE ((__force snd_pcm_format_t) 12)
208 #define SNDRV_PCM_FORMAT_U32_BE ((__force snd_pcm_format_t) 13)
209 #define SNDRV_PCM_FORMAT_FLOAT_LE ((__force snd_pcm_format_t) 14) /* 4-byte float, IEEE-754 32-bit, range -1.0 to 1.0 */
210 #define SNDRV_PCM_FORMAT_FLOAT_BE ((__force snd_pcm_format_t) 15) /* 4-byte float, IEEE-754 32-bit, range -1.0 to 1.0 */
211 #define SNDRV_PCM_FORMAT_FLOAT64_LE ((__force snd_pcm_format_t) 16) /* 8-byte float, IEEE-754 64-bit, range -1.0 to 1.0 */
212 #define SNDRV_PCM_FORMAT_FLOAT64_BE ((__force snd_pcm_format_t) 17) /* 8-byte float, IEEE-754 64-bit, range -1.0 to 1.0 */
213 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE ((__force snd_pcm_format_t) 18) /* IEC-958 subframe, Little Endian */
214 #define SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE ((__force snd_pcm_format_t) 19) /* IEC-958 subframe, Big Endian */
215 #define SNDRV_PCM_FORMAT_MU_LAW ((__force snd_pcm_format_t) 20)
216 #define SNDRV_PCM_FORMAT_A_LAW ((__force snd_pcm_format_t) 21)
217 #define SNDRV_PCM_FORMAT_IMA_ADPCM ((__force snd_pcm_format_t) 22)
218 #define SNDRV_PCM_FORMAT_MPEG ((__force snd_pcm_format_t) 23)
219 #define SNDRV_PCM_FORMAT_GSM ((__force snd_pcm_format_t) 24)
220 #define SNDRV_PCM_FORMAT_S20_LE ((__force snd_pcm_format_t) 25) /* in four bytes, LSB justified */
221 #define SNDRV_PCM_FORMAT_S20_BE ((__force snd_pcm_format_t) 26) /* in four bytes, LSB justified */
222 #define SNDRV_PCM_FORMAT_U20_LE ((__force snd_pcm_format_t) 27) /* in four bytes, LSB justified */
223 #define SNDRV_PCM_FORMAT_U20_BE ((__force 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 ((__force snd_pcm_format_t) 31)
226 #define SNDRV_PCM_FORMAT_S24_3LE ((__force snd_pcm_format_t) 32) /* in three bytes */
227 #define SNDRV_PCM_FORMAT_S24_3BE ((__force snd_pcm_format_t) 33) /* in three bytes */
228 #define SNDRV_PCM_FORMAT_U24_3LE ((__force snd_pcm_format_t) 34) /* in three bytes */
229 #define SNDRV_PCM_FORMAT_U24_3BE ((__force snd_pcm_format_t) 35) /* in three bytes */
230 #define SNDRV_PCM_FORMAT_S20_3LE ((__force snd_pcm_format_t) 36) /* in three bytes */
231 #define SNDRV_PCM_FORMAT_S20_3BE ((__force snd_pcm_format_t) 37) /* in three bytes */
232 #define SNDRV_PCM_FORMAT_U20_3LE ((__force snd_pcm_format_t) 38) /* in three bytes */
233 #define SNDRV_PCM_FORMAT_U20_3BE ((__force snd_pcm_format_t) 39) /* in three bytes */
234 #define SNDRV_PCM_FORMAT_S18_3LE ((__force snd_pcm_format_t) 40) /* in three bytes */
235 #define SNDRV_PCM_FORMAT_S18_3BE ((__force snd_pcm_format_t) 41) /* in three bytes */
236 #define SNDRV_PCM_FORMAT_U18_3LE ((__force snd_pcm_format_t) 42) /* in three bytes */
237 #define SNDRV_PCM_FORMAT_U18_3BE ((__force snd_pcm_format_t) 43) /* in three bytes */
238 #define SNDRV_PCM_FORMAT_G723_24 ((__force snd_pcm_format_t) 44) /* 8 samples in 3 bytes */
239 #define SNDRV_PCM_FORMAT_G723_24_1B ((__force snd_pcm_format_t) 45) /* 1 sample in 1 byte */
240 #define SNDRV_PCM_FORMAT_G723_40 ((__force snd_pcm_format_t) 46) /* 8 Samples in 5 bytes */
241 #define SNDRV_PCM_FORMAT_G723_40_1B ((__force snd_pcm_format_t) 47) /* 1 sample in 1 byte */
242 #define SNDRV_PCM_FORMAT_DSD_U8 ((__force snd_pcm_format_t) 48) /* DSD, 1-byte samples DSD (x8) */
243 #define SNDRV_PCM_FORMAT_DSD_U16_LE ((__force snd_pcm_format_t) 49) /* DSD, 2-byte samples DSD (x16), little endian */
244 #define SNDRV_PCM_FORMAT_DSD_U32_LE ((__force snd_pcm_format_t) 50) /* DSD, 4-byte samples DSD (x32), little endian */
245 #define SNDRV_PCM_FORMAT_DSD_U16_BE ((__force snd_pcm_format_t) 51) /* DSD, 2-byte samples DSD (x16), big endian */
246 #define SNDRV_PCM_FORMAT_DSD_U32_BE ((__force 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
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
277 typedef int __bitwise snd_pcm_subformat_t;
278 #define SNDRV_PCM_SUBFORMAT_STD ((__force snd_pcm_subformat_t) 0)
279 #define SNDRV_PCM_SUBFORMAT_LAST SNDRV_PCM_SUBFORMAT_STD
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 */
303 #define SNDRV_PCM_INFO_DRAIN_TRIGGER 0x40000000 /* internal kernel flag - trigger in drain */
304 #define SNDRV_PCM_INFO_FIFO_IN_FRAMES 0x80000000 /* internal kernel flag - FIFO size is in frames */
306 #if (__BITS_PER_LONG == 32 && defined(__USE_TIME_BITS64)) || defined __KERNEL__
307 #define __SND_STRUCT_TIME64
308 #endif
310 typedef int __bitwise snd_pcm_state_t;
311 #define SNDRV_PCM_STATE_OPEN ((__force snd_pcm_state_t) 0) /* stream is open */
312 #define SNDRV_PCM_STATE_SETUP ((__force snd_pcm_state_t) 1) /* stream has a setup */
313 #define SNDRV_PCM_STATE_PREPARED ((__force snd_pcm_state_t) 2) /* stream is ready to start */
314 #define SNDRV_PCM_STATE_RUNNING ((__force snd_pcm_state_t) 3) /* stream is running */
315 #define SNDRV_PCM_STATE_XRUN ((__force snd_pcm_state_t) 4) /* stream reached an xrun */
316 #define SNDRV_PCM_STATE_DRAINING ((__force snd_pcm_state_t) 5) /* stream is draining */
317 #define SNDRV_PCM_STATE_PAUSED ((__force snd_pcm_state_t) 6) /* stream is paused */
318 #define SNDRV_PCM_STATE_SUSPENDED ((__force snd_pcm_state_t) 7) /* hardware is suspended */
319 #define SNDRV_PCM_STATE_DISCONNECTED ((__force snd_pcm_state_t) 8) /* hardware is disconnected */
320 #define SNDRV_PCM_STATE_LAST SNDRV_PCM_STATE_DISCONNECTED
322 enum {
323 SNDRV_PCM_MMAP_OFFSET_DATA = 0x00000000,
324 SNDRV_PCM_MMAP_OFFSET_STATUS_OLD = 0x80000000,
325 SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD = 0x81000000,
326 SNDRV_PCM_MMAP_OFFSET_STATUS_NEW = 0x82000000,
327 SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW = 0x83000000,
328 #ifdef __SND_STRUCT_TIME64
329 SNDRV_PCM_MMAP_OFFSET_STATUS = SNDRV_PCM_MMAP_OFFSET_STATUS_NEW,
330 SNDRV_PCM_MMAP_OFFSET_CONTROL = SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW,
331 #else
332 SNDRV_PCM_MMAP_OFFSET_STATUS = SNDRV_PCM_MMAP_OFFSET_STATUS_OLD,
333 SNDRV_PCM_MMAP_OFFSET_CONTROL = SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD,
334 #endif
337 union snd_pcm_sync_id {
338 unsigned char id[16];
339 unsigned short id16[8];
340 unsigned int id32[4];
343 struct snd_pcm_info {
344 unsigned int device; /* RO/WR (control): device number */
345 unsigned int subdevice; /* RO/WR (control): subdevice number */
346 int stream; /* RO/WR (control): stream direction */
347 int card; /* R: card number */
348 unsigned char id[64]; /* ID (user selectable) */
349 unsigned char name[80]; /* name of this device */
350 unsigned char subname[32]; /* subdevice name */
351 int dev_class; /* SNDRV_PCM_CLASS_* */
352 int dev_subclass; /* SNDRV_PCM_SUBCLASS_* */
353 unsigned int subdevices_count;
354 unsigned int subdevices_avail;
355 union snd_pcm_sync_id sync; /* hardware synchronization ID */
356 unsigned char reserved[64]; /* reserved for future... */
359 typedef int snd_pcm_hw_param_t;
360 #define SNDRV_PCM_HW_PARAM_ACCESS 0 /* Access type */
361 #define SNDRV_PCM_HW_PARAM_FORMAT 1 /* Format */
362 #define SNDRV_PCM_HW_PARAM_SUBFORMAT 2 /* Subformat */
363 #define SNDRV_PCM_HW_PARAM_FIRST_MASK SNDRV_PCM_HW_PARAM_ACCESS
364 #define SNDRV_PCM_HW_PARAM_LAST_MASK SNDRV_PCM_HW_PARAM_SUBFORMAT
366 #define SNDRV_PCM_HW_PARAM_SAMPLE_BITS 8 /* Bits per sample */
367 #define SNDRV_PCM_HW_PARAM_FRAME_BITS 9 /* Bits per frame */
368 #define SNDRV_PCM_HW_PARAM_CHANNELS 10 /* Channels */
369 #define SNDRV_PCM_HW_PARAM_RATE 11 /* Approx rate */
370 #define SNDRV_PCM_HW_PARAM_PERIOD_TIME 12 /* Approx distance between
371 * interrupts in us
373 #define SNDRV_PCM_HW_PARAM_PERIOD_SIZE 13 /* Approx frames between
374 * interrupts
376 #define SNDRV_PCM_HW_PARAM_PERIOD_BYTES 14 /* Approx bytes between
377 * interrupts
379 #define SNDRV_PCM_HW_PARAM_PERIODS 15 /* Approx interrupts per
380 * buffer
382 #define SNDRV_PCM_HW_PARAM_BUFFER_TIME 16 /* Approx duration of buffer
383 * in us
385 #define SNDRV_PCM_HW_PARAM_BUFFER_SIZE 17 /* Size of buffer in frames */
386 #define SNDRV_PCM_HW_PARAM_BUFFER_BYTES 18 /* Size of buffer in bytes */
387 #define SNDRV_PCM_HW_PARAM_TICK_TIME 19 /* Approx tick duration in us */
388 #define SNDRV_PCM_HW_PARAM_FIRST_INTERVAL SNDRV_PCM_HW_PARAM_SAMPLE_BITS
389 #define SNDRV_PCM_HW_PARAM_LAST_INTERVAL SNDRV_PCM_HW_PARAM_TICK_TIME
391 #define SNDRV_PCM_HW_PARAMS_NORESAMPLE (1<<0) /* avoid rate resampling */
392 #define SNDRV_PCM_HW_PARAMS_EXPORT_BUFFER (1<<1) /* export buffer */
393 #define SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP (1<<2) /* disable period wakeups */
395 struct snd_interval {
396 unsigned int min, max;
397 unsigned int openmin:1,
398 openmax:1,
399 integer:1,
400 empty:1;
403 #define SNDRV_MASK_MAX 256
405 struct snd_mask {
406 __u32 bits[(SNDRV_MASK_MAX+31)/32];
409 struct snd_pcm_hw_params {
410 unsigned int flags;
411 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
412 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
413 struct snd_mask mres[5]; /* reserved masks */
414 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
415 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
416 struct snd_interval ires[9]; /* reserved intervals */
417 unsigned int rmask; /* W: requested masks */
418 unsigned int cmask; /* R: changed masks */
419 unsigned int info; /* R: Info flags for returned setup */
420 unsigned int msbits; /* R: used most significant bits */
421 unsigned int rate_num; /* R: rate numerator */
422 unsigned int rate_den; /* R: rate denominator */
423 snd_pcm_uframes_t fifo_size; /* R: chip FIFO size in frames */
424 unsigned char reserved[64]; /* reserved for future */
427 enum {
428 SNDRV_PCM_TSTAMP_NONE = 0,
429 SNDRV_PCM_TSTAMP_ENABLE,
430 SNDRV_PCM_TSTAMP_LAST = SNDRV_PCM_TSTAMP_ENABLE,
433 struct snd_pcm_sw_params {
434 int tstamp_mode; /* timestamp mode */
435 unsigned int period_step;
436 unsigned int sleep_min; /* min ticks to sleep */
437 snd_pcm_uframes_t avail_min; /* min avail frames for wakeup */
438 snd_pcm_uframes_t xfer_align; /* obsolete: xfer size need to be a multiple */
439 snd_pcm_uframes_t start_threshold; /* min hw_avail frames for automatic start */
440 snd_pcm_uframes_t stop_threshold; /* min avail frames for automatic stop */
441 snd_pcm_uframes_t silence_threshold; /* min distance from noise for silence filling */
442 snd_pcm_uframes_t silence_size; /* silence block size */
443 snd_pcm_uframes_t boundary; /* pointers wrap point */
444 unsigned int proto; /* protocol version */
445 unsigned int tstamp_type; /* timestamp type (req. proto >= 2.0.12) */
446 unsigned char reserved[56]; /* reserved for future */
449 struct snd_pcm_channel_info {
450 unsigned int channel;
451 __kernel_off_t offset; /* mmap offset */
452 unsigned int first; /* offset to first sample in bits */
453 unsigned int step; /* samples distance in bits */
456 enum {
458 * first definition for backwards compatibility only,
459 * maps to wallclock/link time for HDAudio playback and DEFAULT/DMA time for everything else
461 SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT = 0,
463 /* timestamp definitions */
464 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT = 1, /* DMA time, reported as per hw_ptr */
465 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK = 2, /* link time reported by sample or wallclock counter, reset on startup */
466 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_ABSOLUTE = 3, /* link time reported by sample or wallclock counter, not reset on startup */
467 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_ESTIMATED = 4, /* link time estimated indirectly */
468 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_SYNCHRONIZED = 5, /* link time synchronized with system time */
469 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LAST = SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_SYNCHRONIZED
472 #ifndef __KERNEL__
473 /* explicit padding avoids incompatibility between i386 and x86-64 */
474 typedef struct { unsigned char pad[sizeof(time_t) - sizeof(int)]; } __time_pad;
476 struct 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 */
494 #endif
497 * For mmap operations, we need the 64-bit layout, both for compat mode,
498 * and for y2038 compatibility. For 64-bit applications, the two definitions
499 * are identical, so we keep the traditional version.
501 #ifdef __SND_STRUCT_TIME64
502 #define __snd_pcm_mmap_status64 snd_pcm_mmap_status
503 #define __snd_pcm_mmap_control64 snd_pcm_mmap_control
504 #define __snd_pcm_sync_ptr64 snd_pcm_sync_ptr
505 #ifdef __KERNEL__
506 #define __snd_timespec64 __kernel_timespec
507 #else
508 #define __snd_timespec64 timespec
509 #endif
510 struct __snd_timespec {
511 __s32 tv_sec;
512 __s32 tv_nsec;
514 #else
515 #define __snd_pcm_mmap_status snd_pcm_mmap_status
516 #define __snd_pcm_mmap_control snd_pcm_mmap_control
517 #define __snd_pcm_sync_ptr snd_pcm_sync_ptr
518 #define __snd_timespec timespec
519 struct __snd_timespec64 {
520 __s64 tv_sec;
521 __s64 tv_nsec;
524 #endif
526 struct __snd_pcm_mmap_status {
527 snd_pcm_state_t state; /* RO: state - SNDRV_PCM_STATE_XXXX */
528 int pad1; /* Needed for 64 bit alignment */
529 snd_pcm_uframes_t hw_ptr; /* RO: hw ptr (0...boundary-1) */
530 struct __snd_timespec tstamp; /* Timestamp */
531 snd_pcm_state_t suspended_state; /* RO: suspended stream state */
532 struct __snd_timespec audio_tstamp; /* from sample counter or wall clock */
535 struct __snd_pcm_mmap_control {
536 snd_pcm_uframes_t appl_ptr; /* RW: appl ptr (0...boundary-1) */
537 snd_pcm_uframes_t avail_min; /* RW: min available frames for wakeup */
540 #define SNDRV_PCM_SYNC_PTR_HWSYNC (1<<0) /* execute hwsync */
541 #define SNDRV_PCM_SYNC_PTR_APPL (1<<1) /* get appl_ptr from driver (r/w op) */
542 #define SNDRV_PCM_SYNC_PTR_AVAIL_MIN (1<<2) /* get avail_min from driver */
544 struct __snd_pcm_sync_ptr {
545 unsigned int flags;
546 union {
547 struct __snd_pcm_mmap_status status;
548 unsigned char reserved[64];
549 } s;
550 union {
551 struct __snd_pcm_mmap_control control;
552 unsigned char reserved[64];
553 } c;
556 #if defined(__BYTE_ORDER) ? __BYTE_ORDER == __BIG_ENDIAN : defined(__BIG_ENDIAN)
557 typedef char __pad_before_uframe[sizeof(__u64) - sizeof(snd_pcm_uframes_t)];
558 typedef char __pad_after_uframe[0];
559 #endif
561 #if defined(__BYTE_ORDER) ? __BYTE_ORDER == __LITTLE_ENDIAN : defined(__LITTLE_ENDIAN)
562 typedef char __pad_before_uframe[0];
563 typedef char __pad_after_uframe[sizeof(__u64) - sizeof(snd_pcm_uframes_t)];
564 #endif
566 struct __snd_pcm_mmap_status64 {
567 snd_pcm_state_t state; /* RO: state - SNDRV_PCM_STATE_XXXX */
568 __u32 pad1; /* Needed for 64 bit alignment */
569 __pad_before_uframe __pad1;
570 snd_pcm_uframes_t hw_ptr; /* RO: hw ptr (0...boundary-1) */
571 __pad_after_uframe __pad2;
572 struct __snd_timespec64 tstamp; /* Timestamp */
573 snd_pcm_state_t suspended_state;/* RO: suspended stream state */
574 __u32 pad3; /* Needed for 64 bit alignment */
575 struct __snd_timespec64 audio_tstamp; /* sample counter or wall clock */
578 struct __snd_pcm_mmap_control64 {
579 __pad_before_uframe __pad1;
580 snd_pcm_uframes_t appl_ptr; /* RW: appl ptr (0...boundary-1) */
581 __pad_before_uframe __pad2;
583 __pad_before_uframe __pad3;
584 snd_pcm_uframes_t avail_min; /* RW: min available frames for wakeup */
585 __pad_after_uframe __pad4;
588 struct __snd_pcm_sync_ptr64 {
589 __u32 flags;
590 __u32 pad1;
591 union {
592 struct __snd_pcm_mmap_status64 status;
593 unsigned char reserved[64];
594 } s;
595 union {
596 struct __snd_pcm_mmap_control64 control;
597 unsigned char reserved[64];
598 } c;
601 struct snd_xferi {
602 snd_pcm_sframes_t result;
603 void __user *buf;
604 snd_pcm_uframes_t frames;
607 struct snd_xfern {
608 snd_pcm_sframes_t result;
609 void __user * __user *bufs;
610 snd_pcm_uframes_t frames;
613 enum {
614 SNDRV_PCM_TSTAMP_TYPE_GETTIMEOFDAY = 0, /* gettimeofday equivalent */
615 SNDRV_PCM_TSTAMP_TYPE_MONOTONIC, /* posix_clock_monotonic equivalent */
616 SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW, /* monotonic_raw (no NTP) */
617 SNDRV_PCM_TSTAMP_TYPE_LAST = SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW,
620 /* channel positions */
621 enum {
622 SNDRV_CHMAP_UNKNOWN = 0,
623 SNDRV_CHMAP_NA, /* N/A, silent */
624 SNDRV_CHMAP_MONO, /* mono stream */
625 /* this follows the alsa-lib mixer channel value + 3 */
626 SNDRV_CHMAP_FL, /* front left */
627 SNDRV_CHMAP_FR, /* front right */
628 SNDRV_CHMAP_RL, /* rear left */
629 SNDRV_CHMAP_RR, /* rear right */
630 SNDRV_CHMAP_FC, /* front center */
631 SNDRV_CHMAP_LFE, /* LFE */
632 SNDRV_CHMAP_SL, /* side left */
633 SNDRV_CHMAP_SR, /* side right */
634 SNDRV_CHMAP_RC, /* rear center */
635 /* new definitions */
636 SNDRV_CHMAP_FLC, /* front left center */
637 SNDRV_CHMAP_FRC, /* front right center */
638 SNDRV_CHMAP_RLC, /* rear left center */
639 SNDRV_CHMAP_RRC, /* rear right center */
640 SNDRV_CHMAP_FLW, /* front left wide */
641 SNDRV_CHMAP_FRW, /* front right wide */
642 SNDRV_CHMAP_FLH, /* front left high */
643 SNDRV_CHMAP_FCH, /* front center high */
644 SNDRV_CHMAP_FRH, /* front right high */
645 SNDRV_CHMAP_TC, /* top center */
646 SNDRV_CHMAP_TFL, /* top front left */
647 SNDRV_CHMAP_TFR, /* top front right */
648 SNDRV_CHMAP_TFC, /* top front center */
649 SNDRV_CHMAP_TRL, /* top rear left */
650 SNDRV_CHMAP_TRR, /* top rear right */
651 SNDRV_CHMAP_TRC, /* top rear center */
652 /* new definitions for UAC2 */
653 SNDRV_CHMAP_TFLC, /* top front left center */
654 SNDRV_CHMAP_TFRC, /* top front right center */
655 SNDRV_CHMAP_TSL, /* top side left */
656 SNDRV_CHMAP_TSR, /* top side right */
657 SNDRV_CHMAP_LLFE, /* left LFE */
658 SNDRV_CHMAP_RLFE, /* right LFE */
659 SNDRV_CHMAP_BC, /* bottom center */
660 SNDRV_CHMAP_BLC, /* bottom left center */
661 SNDRV_CHMAP_BRC, /* bottom right center */
662 SNDRV_CHMAP_LAST = SNDRV_CHMAP_BRC,
665 #define SNDRV_CHMAP_POSITION_MASK 0xffff
666 #define SNDRV_CHMAP_PHASE_INVERSE (0x01 << 16)
667 #define SNDRV_CHMAP_DRIVER_SPEC (0x02 << 16)
669 #define SNDRV_PCM_IOCTL_PVERSION _IOR('A', 0x00, int)
670 #define SNDRV_PCM_IOCTL_INFO _IOR('A', 0x01, struct snd_pcm_info)
671 #define SNDRV_PCM_IOCTL_TSTAMP _IOW('A', 0x02, int)
672 #define SNDRV_PCM_IOCTL_TTSTAMP _IOW('A', 0x03, int)
673 #define SNDRV_PCM_IOCTL_USER_PVERSION _IOW('A', 0x04, int)
674 #define SNDRV_PCM_IOCTL_HW_REFINE _IOWR('A', 0x10, struct snd_pcm_hw_params)
675 #define SNDRV_PCM_IOCTL_HW_PARAMS _IOWR('A', 0x11, struct snd_pcm_hw_params)
676 #define SNDRV_PCM_IOCTL_HW_FREE _IO('A', 0x12)
677 #define SNDRV_PCM_IOCTL_SW_PARAMS _IOWR('A', 0x13, struct snd_pcm_sw_params)
678 #define SNDRV_PCM_IOCTL_STATUS _IOR('A', 0x20, struct snd_pcm_status)
679 #define SNDRV_PCM_IOCTL_DELAY _IOR('A', 0x21, snd_pcm_sframes_t)
680 #define SNDRV_PCM_IOCTL_HWSYNC _IO('A', 0x22)
681 #define __SNDRV_PCM_IOCTL_SYNC_PTR _IOWR('A', 0x23, struct __snd_pcm_sync_ptr)
682 #define __SNDRV_PCM_IOCTL_SYNC_PTR64 _IOWR('A', 0x23, struct __snd_pcm_sync_ptr64)
683 #define SNDRV_PCM_IOCTL_SYNC_PTR _IOWR('A', 0x23, struct snd_pcm_sync_ptr)
684 #define SNDRV_PCM_IOCTL_STATUS_EXT _IOWR('A', 0x24, struct snd_pcm_status)
685 #define SNDRV_PCM_IOCTL_CHANNEL_INFO _IOR('A', 0x32, struct snd_pcm_channel_info)
686 #define SNDRV_PCM_IOCTL_PREPARE _IO('A', 0x40)
687 #define SNDRV_PCM_IOCTL_RESET _IO('A', 0x41)
688 #define SNDRV_PCM_IOCTL_START _IO('A', 0x42)
689 #define SNDRV_PCM_IOCTL_DROP _IO('A', 0x43)
690 #define SNDRV_PCM_IOCTL_DRAIN _IO('A', 0x44)
691 #define SNDRV_PCM_IOCTL_PAUSE _IOW('A', 0x45, int)
692 #define SNDRV_PCM_IOCTL_REWIND _IOW('A', 0x46, snd_pcm_uframes_t)
693 #define SNDRV_PCM_IOCTL_RESUME _IO('A', 0x47)
694 #define SNDRV_PCM_IOCTL_XRUN _IO('A', 0x48)
695 #define SNDRV_PCM_IOCTL_FORWARD _IOW('A', 0x49, snd_pcm_uframes_t)
696 #define SNDRV_PCM_IOCTL_WRITEI_FRAMES _IOW('A', 0x50, struct snd_xferi)
697 #define SNDRV_PCM_IOCTL_READI_FRAMES _IOR('A', 0x51, struct snd_xferi)
698 #define SNDRV_PCM_IOCTL_WRITEN_FRAMES _IOW('A', 0x52, struct snd_xfern)
699 #define SNDRV_PCM_IOCTL_READN_FRAMES _IOR('A', 0x53, struct snd_xfern)
700 #define SNDRV_PCM_IOCTL_LINK _IOW('A', 0x60, int)
701 #define SNDRV_PCM_IOCTL_UNLINK _IO('A', 0x61)
703 /*****************************************************************************
705 * MIDI v1.0 interface *
707 *****************************************************************************/
710 * Raw MIDI section - /dev/snd/midi??
713 #define SNDRV_RAWMIDI_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 1)
715 enum {
716 SNDRV_RAWMIDI_STREAM_OUTPUT = 0,
717 SNDRV_RAWMIDI_STREAM_INPUT,
718 SNDRV_RAWMIDI_STREAM_LAST = SNDRV_RAWMIDI_STREAM_INPUT,
721 #define SNDRV_RAWMIDI_INFO_OUTPUT 0x00000001
722 #define SNDRV_RAWMIDI_INFO_INPUT 0x00000002
723 #define SNDRV_RAWMIDI_INFO_DUPLEX 0x00000004
725 struct 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 */
739 struct snd_rawmidi_params {
740 int stream;
741 size_t buffer_size; /* queue size in bytes */
742 size_t avail_min; /* minimum avail bytes for wakeup */
743 unsigned int no_active_sensing: 1; /* do not send active sensing byte in close() */
744 unsigned char reserved[16]; /* reserved for future use */
747 #ifndef __KERNEL__
748 struct snd_rawmidi_status {
749 int stream;
750 __time_pad pad1;
751 struct timespec tstamp; /* Timestamp */
752 size_t avail; /* available bytes */
753 size_t xruns; /* count of overruns since last status (in bytes) */
754 unsigned char reserved[16]; /* reserved for future use */
756 #endif
758 #define SNDRV_RAWMIDI_IOCTL_PVERSION _IOR('W', 0x00, int)
759 #define SNDRV_RAWMIDI_IOCTL_INFO _IOR('W', 0x01, struct snd_rawmidi_info)
760 #define SNDRV_RAWMIDI_IOCTL_PARAMS _IOWR('W', 0x10, struct snd_rawmidi_params)
761 #define SNDRV_RAWMIDI_IOCTL_STATUS _IOWR('W', 0x20, struct snd_rawmidi_status)
762 #define SNDRV_RAWMIDI_IOCTL_DROP _IOW('W', 0x30, int)
763 #define SNDRV_RAWMIDI_IOCTL_DRAIN _IOW('W', 0x31, int)
766 * Timer section - /dev/snd/timer
769 #define SNDRV_TIMER_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 7)
771 enum {
772 SNDRV_TIMER_CLASS_NONE = -1,
773 SNDRV_TIMER_CLASS_SLAVE = 0,
774 SNDRV_TIMER_CLASS_GLOBAL,
775 SNDRV_TIMER_CLASS_CARD,
776 SNDRV_TIMER_CLASS_PCM,
777 SNDRV_TIMER_CLASS_LAST = SNDRV_TIMER_CLASS_PCM,
780 /* slave timer classes */
781 enum {
782 SNDRV_TIMER_SCLASS_NONE = 0,
783 SNDRV_TIMER_SCLASS_APPLICATION,
784 SNDRV_TIMER_SCLASS_SEQUENCER, /* alias */
785 SNDRV_TIMER_SCLASS_OSS_SEQUENCER, /* alias */
786 SNDRV_TIMER_SCLASS_LAST = SNDRV_TIMER_SCLASS_OSS_SEQUENCER,
789 /* global timers (device member) */
790 #define SNDRV_TIMER_GLOBAL_SYSTEM 0
791 #define SNDRV_TIMER_GLOBAL_RTC 1 /* unused */
792 #define SNDRV_TIMER_GLOBAL_HPET 2
793 #define SNDRV_TIMER_GLOBAL_HRTIMER 3
795 /* info flags */
796 #define SNDRV_TIMER_FLG_SLAVE (1<<0) /* cannot be controlled */
798 struct snd_timer_id {
799 int dev_class;
800 int dev_sclass;
801 int card;
802 int device;
803 int subdevice;
806 struct snd_timer_ginfo {
807 struct snd_timer_id tid; /* requested timer ID */
808 unsigned int flags; /* timer flags - SNDRV_TIMER_FLG_* */
809 int card; /* card number */
810 unsigned char id[64]; /* timer identification */
811 unsigned char name[80]; /* timer name */
812 unsigned long reserved0; /* reserved for future use */
813 unsigned long resolution; /* average period resolution in ns */
814 unsigned long resolution_min; /* minimal period resolution in ns */
815 unsigned long resolution_max; /* maximal period resolution in ns */
816 unsigned int clients; /* active timer clients */
817 unsigned char reserved[32];
820 struct snd_timer_gparams {
821 struct snd_timer_id tid; /* requested timer ID */
822 unsigned long period_num; /* requested precise period duration (in seconds) - numerator */
823 unsigned long period_den; /* requested precise period duration (in seconds) - denominator */
824 unsigned char reserved[32];
827 struct snd_timer_gstatus {
828 struct snd_timer_id tid; /* requested timer ID */
829 unsigned long resolution; /* current period resolution in ns */
830 unsigned long resolution_num; /* precise current period resolution (in seconds) - numerator */
831 unsigned long resolution_den; /* precise current period resolution (in seconds) - denominator */
832 unsigned char reserved[32];
835 struct snd_timer_select {
836 struct snd_timer_id id; /* bind to timer ID */
837 unsigned char reserved[32]; /* reserved */
840 struct snd_timer_info {
841 unsigned int flags; /* timer flags - SNDRV_TIMER_FLG_* */
842 int card; /* card number */
843 unsigned char id[64]; /* timer identificator */
844 unsigned char name[80]; /* timer name */
845 unsigned long reserved0; /* reserved for future use */
846 unsigned long resolution; /* average period resolution in ns */
847 unsigned char reserved[64]; /* reserved */
850 #define SNDRV_TIMER_PSFLG_AUTO (1<<0) /* auto start, otherwise one-shot */
851 #define SNDRV_TIMER_PSFLG_EXCLUSIVE (1<<1) /* exclusive use, precise start/stop/pause/continue */
852 #define SNDRV_TIMER_PSFLG_EARLY_EVENT (1<<2) /* write early event to the poll queue */
854 struct snd_timer_params {
855 unsigned int flags; /* flags - SNDRV_TIMER_PSFLG_* */
856 unsigned int ticks; /* requested resolution in ticks */
857 unsigned int queue_size; /* total size of queue (32-1024) */
858 unsigned int reserved0; /* reserved, was: failure locations */
859 unsigned int filter; /* event filter (bitmask of SNDRV_TIMER_EVENT_*) */
860 unsigned char reserved[60]; /* reserved */
863 #ifndef __KERNEL__
864 struct snd_timer_status {
865 struct timespec tstamp; /* Timestamp - last update */
866 unsigned int resolution; /* current period resolution in ns */
867 unsigned int lost; /* counter of master tick lost */
868 unsigned int overrun; /* count of read queue overruns */
869 unsigned int queue; /* used queue size */
870 unsigned char reserved[64]; /* reserved */
872 #endif
874 #define SNDRV_TIMER_IOCTL_PVERSION _IOR('T', 0x00, int)
875 #define SNDRV_TIMER_IOCTL_NEXT_DEVICE _IOWR('T', 0x01, struct snd_timer_id)
876 #define SNDRV_TIMER_IOCTL_TREAD_OLD _IOW('T', 0x02, int)
877 #define SNDRV_TIMER_IOCTL_GINFO _IOWR('T', 0x03, struct snd_timer_ginfo)
878 #define SNDRV_TIMER_IOCTL_GPARAMS _IOW('T', 0x04, struct snd_timer_gparams)
879 #define SNDRV_TIMER_IOCTL_GSTATUS _IOWR('T', 0x05, struct snd_timer_gstatus)
880 #define SNDRV_TIMER_IOCTL_SELECT _IOW('T', 0x10, struct snd_timer_select)
881 #define SNDRV_TIMER_IOCTL_INFO _IOR('T', 0x11, struct snd_timer_info)
882 #define SNDRV_TIMER_IOCTL_PARAMS _IOW('T', 0x12, struct snd_timer_params)
883 #define SNDRV_TIMER_IOCTL_STATUS _IOR('T', 0x14, struct snd_timer_status)
884 /* The following four ioctls are changed since 1.0.9 due to confliction */
885 #define SNDRV_TIMER_IOCTL_START _IO('T', 0xa0)
886 #define SNDRV_TIMER_IOCTL_STOP _IO('T', 0xa1)
887 #define SNDRV_TIMER_IOCTL_CONTINUE _IO('T', 0xa2)
888 #define SNDRV_TIMER_IOCTL_PAUSE _IO('T', 0xa3)
889 #define SNDRV_TIMER_IOCTL_TREAD64 _IOW('T', 0xa4, int)
891 #if __BITS_PER_LONG == 64
892 #define SNDRV_TIMER_IOCTL_TREAD SNDRV_TIMER_IOCTL_TREAD_OLD
893 #else
894 #define SNDRV_TIMER_IOCTL_TREAD ((sizeof(__kernel_long_t) >= sizeof(time_t)) ? \
895 SNDRV_TIMER_IOCTL_TREAD_OLD : \
896 SNDRV_TIMER_IOCTL_TREAD64)
897 #endif
899 struct snd_timer_read {
900 unsigned int resolution;
901 unsigned int ticks;
904 enum {
905 SNDRV_TIMER_EVENT_RESOLUTION = 0, /* val = resolution in ns */
906 SNDRV_TIMER_EVENT_TICK, /* val = ticks */
907 SNDRV_TIMER_EVENT_START, /* val = resolution in ns */
908 SNDRV_TIMER_EVENT_STOP, /* val = 0 */
909 SNDRV_TIMER_EVENT_CONTINUE, /* val = resolution in ns */
910 SNDRV_TIMER_EVENT_PAUSE, /* val = 0 */
911 SNDRV_TIMER_EVENT_EARLY, /* val = 0, early event */
912 SNDRV_TIMER_EVENT_SUSPEND, /* val = 0 */
913 SNDRV_TIMER_EVENT_RESUME, /* val = resolution in ns */
914 /* master timer events for slave timer instances */
915 SNDRV_TIMER_EVENT_MSTART = SNDRV_TIMER_EVENT_START + 10,
916 SNDRV_TIMER_EVENT_MSTOP = SNDRV_TIMER_EVENT_STOP + 10,
917 SNDRV_TIMER_EVENT_MCONTINUE = SNDRV_TIMER_EVENT_CONTINUE + 10,
918 SNDRV_TIMER_EVENT_MPAUSE = SNDRV_TIMER_EVENT_PAUSE + 10,
919 SNDRV_TIMER_EVENT_MSUSPEND = SNDRV_TIMER_EVENT_SUSPEND + 10,
920 SNDRV_TIMER_EVENT_MRESUME = SNDRV_TIMER_EVENT_RESUME + 10,
923 #ifndef __KERNEL__
924 struct snd_timer_tread {
925 int event;
926 __time_pad pad1;
927 struct timespec tstamp;
928 unsigned int val;
929 __time_pad pad2;
931 #endif
933 /****************************************************************************
935 * Section for driver control interface - /dev/snd/control? *
937 ****************************************************************************/
939 #define SNDRV_CTL_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 8)
941 struct snd_ctl_card_info {
942 int card; /* card number */
943 int pad; /* reserved for future (was type) */
944 unsigned char id[16]; /* ID of card (user selectable) */
945 unsigned char driver[16]; /* Driver name */
946 unsigned char name[32]; /* Short name of soundcard */
947 unsigned char longname[80]; /* name + info text about soundcard */
948 unsigned char reserved_[16]; /* reserved for future (was ID of mixer) */
949 unsigned char mixername[80]; /* visual mixer identification */
950 unsigned char components[128]; /* card components / fine identification, delimited with one space (AC97 etc..) */
953 typedef int __bitwise snd_ctl_elem_type_t;
954 #define SNDRV_CTL_ELEM_TYPE_NONE ((__force snd_ctl_elem_type_t) 0) /* invalid */
955 #define SNDRV_CTL_ELEM_TYPE_BOOLEAN ((__force snd_ctl_elem_type_t) 1) /* boolean type */
956 #define SNDRV_CTL_ELEM_TYPE_INTEGER ((__force snd_ctl_elem_type_t) 2) /* integer type */
957 #define SNDRV_CTL_ELEM_TYPE_ENUMERATED ((__force snd_ctl_elem_type_t) 3) /* enumerated type */
958 #define SNDRV_CTL_ELEM_TYPE_BYTES ((__force snd_ctl_elem_type_t) 4) /* byte array */
959 #define SNDRV_CTL_ELEM_TYPE_IEC958 ((__force snd_ctl_elem_type_t) 5) /* IEC958 (S/PDIF) setup */
960 #define SNDRV_CTL_ELEM_TYPE_INTEGER64 ((__force snd_ctl_elem_type_t) 6) /* 64-bit integer type */
961 #define SNDRV_CTL_ELEM_TYPE_LAST SNDRV_CTL_ELEM_TYPE_INTEGER64
963 typedef int __bitwise snd_ctl_elem_iface_t;
964 #define SNDRV_CTL_ELEM_IFACE_CARD ((__force snd_ctl_elem_iface_t) 0) /* global control */
965 #define SNDRV_CTL_ELEM_IFACE_HWDEP ((__force snd_ctl_elem_iface_t) 1) /* hardware dependent device */
966 #define SNDRV_CTL_ELEM_IFACE_MIXER ((__force snd_ctl_elem_iface_t) 2) /* virtual mixer device */
967 #define SNDRV_CTL_ELEM_IFACE_PCM ((__force snd_ctl_elem_iface_t) 3) /* PCM device */
968 #define SNDRV_CTL_ELEM_IFACE_RAWMIDI ((__force snd_ctl_elem_iface_t) 4) /* RawMidi device */
969 #define SNDRV_CTL_ELEM_IFACE_TIMER ((__force snd_ctl_elem_iface_t) 5) /* timer device */
970 #define SNDRV_CTL_ELEM_IFACE_SEQUENCER ((__force snd_ctl_elem_iface_t) 6) /* sequencer client */
971 #define SNDRV_CTL_ELEM_IFACE_LAST SNDRV_CTL_ELEM_IFACE_SEQUENCER
973 #define SNDRV_CTL_ELEM_ACCESS_READ (1<<0)
974 #define SNDRV_CTL_ELEM_ACCESS_WRITE (1<<1)
975 #define SNDRV_CTL_ELEM_ACCESS_READWRITE (SNDRV_CTL_ELEM_ACCESS_READ|SNDRV_CTL_ELEM_ACCESS_WRITE)
976 #define SNDRV_CTL_ELEM_ACCESS_VOLATILE (1<<2) /* control value may be changed without a notification */
977 // (1 << 3) is unused.
978 #define SNDRV_CTL_ELEM_ACCESS_TLV_READ (1<<4) /* TLV read is possible */
979 #define SNDRV_CTL_ELEM_ACCESS_TLV_WRITE (1<<5) /* TLV write is possible */
980 #define SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE (SNDRV_CTL_ELEM_ACCESS_TLV_READ|SNDRV_CTL_ELEM_ACCESS_TLV_WRITE)
981 #define SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND (1<<6) /* TLV command is possible */
982 #define SNDRV_CTL_ELEM_ACCESS_INACTIVE (1<<8) /* control does actually nothing, but may be updated */
983 #define SNDRV_CTL_ELEM_ACCESS_LOCK (1<<9) /* write lock */
984 #define SNDRV_CTL_ELEM_ACCESS_OWNER (1<<10) /* write lock owner */
985 #define SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK (1<<28) /* kernel use a TLV callback */
986 #define SNDRV_CTL_ELEM_ACCESS_USER (1<<29) /* user space element */
987 /* bits 30 and 31 are obsoleted (for indirect access) */
989 /* for further details see the ACPI and PCI power management specification */
990 #define SNDRV_CTL_POWER_D0 0x0000 /* full On */
991 #define SNDRV_CTL_POWER_D1 0x0100 /* partial On */
992 #define SNDRV_CTL_POWER_D2 0x0200 /* partial On */
993 #define SNDRV_CTL_POWER_D3 0x0300 /* Off */
994 #define SNDRV_CTL_POWER_D3hot (SNDRV_CTL_POWER_D3|0x0000) /* Off, with power */
995 #define SNDRV_CTL_POWER_D3cold (SNDRV_CTL_POWER_D3|0x0001) /* Off, without power */
997 #define SNDRV_CTL_ELEM_ID_NAME_MAXLEN 44
999 struct snd_ctl_elem_id {
1000 unsigned int numid; /* numeric identifier, zero = invalid */
1001 snd_ctl_elem_iface_t iface; /* interface identifier */
1002 unsigned int device; /* device/client number */
1003 unsigned int subdevice; /* subdevice (substream) number */
1004 unsigned char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN]; /* ASCII name of item */
1005 unsigned int index; /* index of item */
1008 struct snd_ctl_elem_list {
1009 unsigned int offset; /* W: first element ID to get */
1010 unsigned int space; /* W: count of element IDs to get */
1011 unsigned int used; /* R: count of element IDs set */
1012 unsigned int count; /* R: count of all elements */
1013 struct snd_ctl_elem_id __user *pids; /* R: IDs */
1014 unsigned char reserved[50];
1017 struct snd_ctl_elem_info {
1018 struct snd_ctl_elem_id id; /* W: element ID */
1019 snd_ctl_elem_type_t type; /* R: value type - SNDRV_CTL_ELEM_TYPE_* */
1020 unsigned int access; /* R: value access (bitmask) - SNDRV_CTL_ELEM_ACCESS_* */
1021 unsigned int count; /* count of values */
1022 __kernel_pid_t owner; /* owner's PID of this control */
1023 union {
1024 struct {
1025 long min; /* R: minimum value */
1026 long max; /* R: maximum value */
1027 long step; /* R: step (0 variable) */
1028 } integer;
1029 struct {
1030 long long min; /* R: minimum value */
1031 long long max; /* R: maximum value */
1032 long long step; /* R: step (0 variable) */
1033 } integer64;
1034 struct {
1035 unsigned int items; /* R: number of items */
1036 unsigned int item; /* W: item number */
1037 char name[64]; /* R: value name */
1038 __u64 names_ptr; /* W: names list (ELEM_ADD only) */
1039 unsigned int names_length;
1040 } enumerated;
1041 unsigned char reserved[128];
1042 } value;
1043 unsigned char reserved[64];
1046 struct snd_ctl_elem_value {
1047 struct snd_ctl_elem_id id; /* W: element ID */
1048 unsigned int indirect: 1; /* W: indirect access - obsoleted */
1049 union {
1050 union {
1051 long value[128];
1052 long *value_ptr; /* obsoleted */
1053 } integer;
1054 union {
1055 long long value[64];
1056 long long *value_ptr; /* obsoleted */
1057 } integer64;
1058 union {
1059 unsigned int item[128];
1060 unsigned int *item_ptr; /* obsoleted */
1061 } enumerated;
1062 union {
1063 unsigned char data[512];
1064 unsigned char *data_ptr; /* obsoleted */
1065 } bytes;
1066 struct snd_aes_iec958 iec958;
1067 } value; /* RO */
1068 unsigned char reserved[128];
1071 struct snd_ctl_tlv {
1072 unsigned int numid; /* control element numeric identification */
1073 unsigned int length; /* in bytes aligned to 4 */
1074 unsigned int tlv[0]; /* first TLV */
1077 #define SNDRV_CTL_IOCTL_PVERSION _IOR('U', 0x00, int)
1078 #define SNDRV_CTL_IOCTL_CARD_INFO _IOR('U', 0x01, struct snd_ctl_card_info)
1079 #define SNDRV_CTL_IOCTL_ELEM_LIST _IOWR('U', 0x10, struct snd_ctl_elem_list)
1080 #define SNDRV_CTL_IOCTL_ELEM_INFO _IOWR('U', 0x11, struct snd_ctl_elem_info)
1081 #define SNDRV_CTL_IOCTL_ELEM_READ _IOWR('U', 0x12, struct snd_ctl_elem_value)
1082 #define SNDRV_CTL_IOCTL_ELEM_WRITE _IOWR('U', 0x13, struct snd_ctl_elem_value)
1083 #define SNDRV_CTL_IOCTL_ELEM_LOCK _IOW('U', 0x14, struct snd_ctl_elem_id)
1084 #define SNDRV_CTL_IOCTL_ELEM_UNLOCK _IOW('U', 0x15, struct snd_ctl_elem_id)
1085 #define SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS _IOWR('U', 0x16, int)
1086 #define SNDRV_CTL_IOCTL_ELEM_ADD _IOWR('U', 0x17, struct snd_ctl_elem_info)
1087 #define SNDRV_CTL_IOCTL_ELEM_REPLACE _IOWR('U', 0x18, struct snd_ctl_elem_info)
1088 #define SNDRV_CTL_IOCTL_ELEM_REMOVE _IOWR('U', 0x19, struct snd_ctl_elem_id)
1089 #define SNDRV_CTL_IOCTL_TLV_READ _IOWR('U', 0x1a, struct snd_ctl_tlv)
1090 #define SNDRV_CTL_IOCTL_TLV_WRITE _IOWR('U', 0x1b, struct snd_ctl_tlv)
1091 #define SNDRV_CTL_IOCTL_TLV_COMMAND _IOWR('U', 0x1c, struct snd_ctl_tlv)
1092 #define SNDRV_CTL_IOCTL_HWDEP_NEXT_DEVICE _IOWR('U', 0x20, int)
1093 #define SNDRV_CTL_IOCTL_HWDEP_INFO _IOR('U', 0x21, struct snd_hwdep_info)
1094 #define SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE _IOR('U', 0x30, int)
1095 #define SNDRV_CTL_IOCTL_PCM_INFO _IOWR('U', 0x31, struct snd_pcm_info)
1096 #define SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE _IOW('U', 0x32, int)
1097 #define SNDRV_CTL_IOCTL_RAWMIDI_NEXT_DEVICE _IOWR('U', 0x40, int)
1098 #define SNDRV_CTL_IOCTL_RAWMIDI_INFO _IOWR('U', 0x41, struct snd_rawmidi_info)
1099 #define SNDRV_CTL_IOCTL_RAWMIDI_PREFER_SUBDEVICE _IOW('U', 0x42, int)
1100 #define SNDRV_CTL_IOCTL_POWER _IOWR('U', 0xd0, int)
1101 #define SNDRV_CTL_IOCTL_POWER_STATE _IOR('U', 0xd1, int)
1104 * Read interface.
1107 enum sndrv_ctl_event_type {
1108 SNDRV_CTL_EVENT_ELEM = 0,
1109 SNDRV_CTL_EVENT_LAST = SNDRV_CTL_EVENT_ELEM,
1112 #define SNDRV_CTL_EVENT_MASK_VALUE (1<<0) /* element value was changed */
1113 #define SNDRV_CTL_EVENT_MASK_INFO (1<<1) /* element info was changed */
1114 #define SNDRV_CTL_EVENT_MASK_ADD (1<<2) /* element was added */
1115 #define SNDRV_CTL_EVENT_MASK_TLV (1<<3) /* element TLV tree was changed */
1116 #define SNDRV_CTL_EVENT_MASK_REMOVE (~0U) /* element was removed */
1118 struct snd_ctl_event {
1119 int type; /* event type - SNDRV_CTL_EVENT_* */
1120 union {
1121 struct {
1122 unsigned int mask;
1123 struct snd_ctl_elem_id id;
1124 } elem;
1125 unsigned char data8[60];
1126 } data;
1130 * Control names
1133 #define SNDRV_CTL_NAME_NONE ""
1134 #define SNDRV_CTL_NAME_PLAYBACK "Playback "
1135 #define SNDRV_CTL_NAME_CAPTURE "Capture "
1137 #define SNDRV_CTL_NAME_IEC958_NONE ""
1138 #define SNDRV_CTL_NAME_IEC958_SWITCH "Switch"
1139 #define SNDRV_CTL_NAME_IEC958_VOLUME "Volume"
1140 #define SNDRV_CTL_NAME_IEC958_DEFAULT "Default"
1141 #define SNDRV_CTL_NAME_IEC958_MASK "Mask"
1142 #define SNDRV_CTL_NAME_IEC958_CON_MASK "Con Mask"
1143 #define SNDRV_CTL_NAME_IEC958_PRO_MASK "Pro Mask"
1144 #define SNDRV_CTL_NAME_IEC958_PCM_STREAM "PCM Stream"
1145 #define SNDRV_CTL_NAME_IEC958(expl,direction,what) "IEC958 " expl SNDRV_CTL_NAME_##direction SNDRV_CTL_NAME_IEC958_##what
1147 #endif /* _UAPI__SOUND_ASOUND_H */