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