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