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