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