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