xref: /openbmc/linux/include/uapi/sound/asound.h (revision 01dfa8e9)
1e2be04c7SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2674e95caSDavid Howells /*
3674e95caSDavid Howells  *  Advanced Linux Sound Architecture - ALSA - Driver
4674e95caSDavid Howells  *  Copyright (c) 1994-2003 by Jaroslav Kysela <perex@perex.cz>,
5674e95caSDavid Howells  *                             Abramo Bagnara <abramo@alsa-project.org>
6674e95caSDavid Howells  */
7674e95caSDavid Howells 
8674e95caSDavid Howells #ifndef _UAPI__SOUND_ASOUND_H
9674e95caSDavid Howells #define _UAPI__SOUND_ASOUND_H
10674e95caSDavid Howells 
1159e42827SThomas Klausner #if defined(__KERNEL__) || defined(__linux__)
12674e95caSDavid Howells #include <linux/types.h>
137fd7d6c5STakashi Iwai #include <asm/byteorder.h>
1459e42827SThomas Klausner #else
157fd7d6c5STakashi Iwai #include <endian.h>
1659e42827SThomas Klausner #include <sys/ioctl.h>
1759e42827SThomas Klausner #endif
18674e95caSDavid Howells 
194bebf709SMikko Rapeli #ifndef __KERNEL__
204bebf709SMikko Rapeli #include <stdlib.h>
21b5bdbb6cSDaniel Mentz #include <time.h>
224bebf709SMikko Rapeli #endif
23674e95caSDavid Howells 
24674e95caSDavid Howells /*
25674e95caSDavid Howells  *  protocol version
26674e95caSDavid Howells  */
27674e95caSDavid Howells 
28674e95caSDavid Howells #define SNDRV_PROTOCOL_VERSION(major, minor, subminor) (((major)<<16)|((minor)<<8)|(subminor))
29674e95caSDavid Howells #define SNDRV_PROTOCOL_MAJOR(version) (((version)>>16)&0xffff)
30674e95caSDavid Howells #define SNDRV_PROTOCOL_MINOR(version) (((version)>>8)&0xff)
31674e95caSDavid Howells #define SNDRV_PROTOCOL_MICRO(version) ((version)&0xff)
32674e95caSDavid Howells #define SNDRV_PROTOCOL_INCOMPATIBLE(kversion, uversion) \
33674e95caSDavid Howells 	(SNDRV_PROTOCOL_MAJOR(kversion) != SNDRV_PROTOCOL_MAJOR(uversion) || \
34674e95caSDavid Howells 	 (SNDRV_PROTOCOL_MAJOR(kversion) == SNDRV_PROTOCOL_MAJOR(uversion) && \
35674e95caSDavid Howells 	   SNDRV_PROTOCOL_MINOR(kversion) != SNDRV_PROTOCOL_MINOR(uversion)))
36674e95caSDavid Howells 
37674e95caSDavid Howells /****************************************************************************
38674e95caSDavid Howells  *                                                                          *
39674e95caSDavid Howells  *        Digital audio interface					    *
40674e95caSDavid Howells  *                                                                          *
41674e95caSDavid Howells  ****************************************************************************/
42674e95caSDavid Howells 
4306feec60SDmitry Osipenko #define AES_IEC958_STATUS_SIZE		24
4406feec60SDmitry Osipenko 
45674e95caSDavid Howells struct snd_aes_iec958 {
4606feec60SDmitry Osipenko 	unsigned char status[AES_IEC958_STATUS_SIZE]; /* AES/IEC958 channel status bits */
47674e95caSDavid Howells 	unsigned char subcode[147];	/* AES/IEC958 subcode bits */
48674e95caSDavid Howells 	unsigned char pad;		/* nothing */
49674e95caSDavid Howells 	unsigned char dig_subframe[4];	/* AES/IEC958 subframe bits */
50674e95caSDavid Howells };
51674e95caSDavid Howells 
52674e95caSDavid Howells /****************************************************************************
53674e95caSDavid Howells  *                                                                          *
54674e95caSDavid Howells  *        CEA-861 Audio InfoFrame. Used in HDMI and DisplayPort		    *
55674e95caSDavid Howells  *                                                                          *
56674e95caSDavid Howells  ****************************************************************************/
57674e95caSDavid Howells 
58674e95caSDavid Howells struct snd_cea_861_aud_if {
59674e95caSDavid Howells 	unsigned char db1_ct_cc; /* coding type and channel count */
60674e95caSDavid Howells 	unsigned char db2_sf_ss; /* sample frequency and size */
61674e95caSDavid Howells 	unsigned char db3; /* not used, all zeros */
62674e95caSDavid Howells 	unsigned char db4_ca; /* channel allocation code */
63674e95caSDavid Howells 	unsigned char db5_dminh_lsv; /* downmix inhibit & level-shit values */
64674e95caSDavid Howells };
65674e95caSDavid Howells 
66674e95caSDavid Howells /****************************************************************************
67674e95caSDavid Howells  *                                                                          *
68674e95caSDavid Howells  *      Section for driver hardware dependent interface - /dev/snd/hw?      *
69674e95caSDavid Howells  *                                                                          *
70674e95caSDavid Howells  ****************************************************************************/
71674e95caSDavid Howells 
72674e95caSDavid Howells #define SNDRV_HWDEP_VERSION		SNDRV_PROTOCOL_VERSION(1, 0, 1)
73674e95caSDavid Howells 
74674e95caSDavid Howells enum {
75674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_OPL2 = 0,
76674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_OPL3,
77674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_OPL4,
78674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_SB16CSP,	/* Creative Signal Processor */
79674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_EMU10K1,	/* FX8010 processor in EMU10K1 chip */
80674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_YSS225,	/* Yamaha FX processor */
81674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_ICS2115,	/* Wavetable synth */
82674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_SSCAPE,	/* Ensoniq SoundScape ISA card (MC68EC000) */
83674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_VX,		/* Digigram VX cards */
84674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_MIXART,	/* Digigram miXart cards */
85674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_USX2Y,	/* Tascam US122, US224 & US428 usb */
86674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_EMUX_WAVETABLE, /* EmuX wavetable */
87674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_BLUETOOTH,	/* Bluetooth audio */
88674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_USX2Y_PCM,	/* Tascam US122, US224 & US428 rawusb pcm */
89674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_PCXHR,	/* Digigram PCXHR */
90674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_SB_RC,	/* SB Extigy/Audigy2NX remote control */
91674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_HDA,		/* HD-audio */
92674e95caSDavid Howells 	SNDRV_HWDEP_IFACE_USB_STREAM,	/* direct access to usb stream */
9382fbb4f7SClemens Ladisch 	SNDRV_HWDEP_IFACE_FW_DICE,	/* TC DICE FireWire device */
94594ddcedSTakashi Sakamoto 	SNDRV_HWDEP_IFACE_FW_FIREWORKS,	/* Echo Audio Fireworks based device */
95618eabeaSTakashi Sakamoto 	SNDRV_HWDEP_IFACE_FW_BEBOB,	/* BridgeCo BeBoB based device */
968985f4acSTakashi Sakamoto 	SNDRV_HWDEP_IFACE_FW_OXFW,	/* Oxford OXFW970/971 based device */
97660dd3d5STakashi Sakamoto 	SNDRV_HWDEP_IFACE_FW_DIGI00X,	/* Digidesign Digi 002/003 family */
98e5e0c3ddSTakashi Sakamoto 	SNDRV_HWDEP_IFACE_FW_TASCAM,	/* TASCAM FireWire series */
99a16039cbSAndrej Krutak 	SNDRV_HWDEP_IFACE_LINE6,	/* Line6 USB processors */
10071c37977STakashi Sakamoto 	SNDRV_HWDEP_IFACE_FW_MOTU,	/* MOTU FireWire series */
101f656edd5STakashi Sakamoto 	SNDRV_HWDEP_IFACE_FW_FIREFACE,	/* RME Fireface series */
102674e95caSDavid Howells 
103674e95caSDavid Howells 	/* Don't forget to change the following: */
104f656edd5STakashi Sakamoto 	SNDRV_HWDEP_IFACE_LAST = SNDRV_HWDEP_IFACE_FW_FIREFACE
105674e95caSDavid Howells };
106674e95caSDavid Howells 
107674e95caSDavid Howells struct snd_hwdep_info {
108674e95caSDavid Howells 	unsigned int device;		/* WR: device number */
109674e95caSDavid Howells 	int card;			/* R: card number */
110674e95caSDavid Howells 	unsigned char id[64];		/* ID (user selectable) */
111674e95caSDavid Howells 	unsigned char name[80];		/* hwdep name */
112674e95caSDavid Howells 	int iface;			/* hwdep interface */
113674e95caSDavid Howells 	unsigned char reserved[64];	/* reserved for future */
114674e95caSDavid Howells };
115674e95caSDavid Howells 
116674e95caSDavid Howells /* generic DSP loader */
117674e95caSDavid Howells struct snd_hwdep_dsp_status {
118674e95caSDavid Howells 	unsigned int version;		/* R: driver-specific version */
119674e95caSDavid Howells 	unsigned char id[32];		/* R: driver-specific ID string */
120674e95caSDavid Howells 	unsigned int num_dsps;		/* R: number of DSP images to transfer */
121674e95caSDavid Howells 	unsigned int dsp_loaded;	/* R: bit flags indicating the loaded DSPs */
122674e95caSDavid Howells 	unsigned int chip_ready;	/* R: 1 = initialization finished */
123674e95caSDavid Howells 	unsigned char reserved[16];	/* reserved for future use */
124674e95caSDavid Howells };
125674e95caSDavid Howells 
126674e95caSDavid Howells struct snd_hwdep_dsp_image {
127674e95caSDavid Howells 	unsigned int index;		/* W: DSP index */
128674e95caSDavid Howells 	unsigned char name[64];		/* W: ID (e.g. file name) */
129674e95caSDavid Howells 	unsigned char __user *image;	/* W: binary image */
130674e95caSDavid Howells 	size_t length;			/* W: size of image in bytes */
131674e95caSDavid Howells 	unsigned long driver_data;	/* W: driver-specific data */
132674e95caSDavid Howells };
133674e95caSDavid Howells 
134674e95caSDavid Howells #define SNDRV_HWDEP_IOCTL_PVERSION	_IOR ('H', 0x00, int)
135674e95caSDavid Howells #define SNDRV_HWDEP_IOCTL_INFO		_IOR ('H', 0x01, struct snd_hwdep_info)
136674e95caSDavid Howells #define SNDRV_HWDEP_IOCTL_DSP_STATUS	_IOR('H', 0x02, struct snd_hwdep_dsp_status)
137674e95caSDavid Howells #define SNDRV_HWDEP_IOCTL_DSP_LOAD	_IOW('H', 0x03, struct snd_hwdep_dsp_image)
138674e95caSDavid Howells 
139674e95caSDavid Howells /*****************************************************************************
140674e95caSDavid Howells  *                                                                           *
141674e95caSDavid Howells  *             Digital Audio (PCM) interface - /dev/snd/pcm??                *
142674e95caSDavid Howells  *                                                                           *
143674e95caSDavid Howells  *****************************************************************************/
144674e95caSDavid Howells 
1451cfaef96SArnd Bergmann #define SNDRV_PCM_VERSION		SNDRV_PROTOCOL_VERSION(2, 0, 15)
146674e95caSDavid Howells 
147674e95caSDavid Howells typedef unsigned long snd_pcm_uframes_t;
148674e95caSDavid Howells typedef signed long snd_pcm_sframes_t;
149674e95caSDavid Howells 
150674e95caSDavid Howells enum {
151674e95caSDavid Howells 	SNDRV_PCM_CLASS_GENERIC = 0,	/* standard mono or stereo device */
152674e95caSDavid Howells 	SNDRV_PCM_CLASS_MULTI,		/* multichannel device */
153674e95caSDavid Howells 	SNDRV_PCM_CLASS_MODEM,		/* software modem class */
154674e95caSDavid Howells 	SNDRV_PCM_CLASS_DIGITIZER,	/* digitizer class */
155674e95caSDavid Howells 	/* Don't forget to change the following: */
156674e95caSDavid Howells 	SNDRV_PCM_CLASS_LAST = SNDRV_PCM_CLASS_DIGITIZER,
157674e95caSDavid Howells };
158674e95caSDavid Howells 
159674e95caSDavid Howells enum {
160674e95caSDavid Howells 	SNDRV_PCM_SUBCLASS_GENERIC_MIX = 0, /* mono or stereo subdevices are mixed together */
161674e95caSDavid Howells 	SNDRV_PCM_SUBCLASS_MULTI_MIX,	/* multichannel subdevices are mixed together */
162674e95caSDavid Howells 	/* Don't forget to change the following: */
163674e95caSDavid Howells 	SNDRV_PCM_SUBCLASS_LAST = SNDRV_PCM_SUBCLASS_MULTI_MIX,
164674e95caSDavid Howells };
165674e95caSDavid Howells 
166674e95caSDavid Howells enum {
167674e95caSDavid Howells 	SNDRV_PCM_STREAM_PLAYBACK = 0,
168674e95caSDavid Howells 	SNDRV_PCM_STREAM_CAPTURE,
169674e95caSDavid Howells 	SNDRV_PCM_STREAM_LAST = SNDRV_PCM_STREAM_CAPTURE,
170674e95caSDavid Howells };
171674e95caSDavid Howells 
172674e95caSDavid Howells typedef int __bitwise snd_pcm_access_t;
173674e95caSDavid Howells #define	SNDRV_PCM_ACCESS_MMAP_INTERLEAVED	((__force snd_pcm_access_t) 0) /* interleaved mmap */
174674e95caSDavid Howells #define	SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED	((__force snd_pcm_access_t) 1) /* noninterleaved mmap */
175674e95caSDavid Howells #define	SNDRV_PCM_ACCESS_MMAP_COMPLEX		((__force snd_pcm_access_t) 2) /* complex mmap */
176674e95caSDavid Howells #define	SNDRV_PCM_ACCESS_RW_INTERLEAVED		((__force snd_pcm_access_t) 3) /* readi/writei */
177674e95caSDavid Howells #define	SNDRV_PCM_ACCESS_RW_NONINTERLEAVED	((__force snd_pcm_access_t) 4) /* readn/writen */
178674e95caSDavid Howells #define	SNDRV_PCM_ACCESS_LAST		SNDRV_PCM_ACCESS_RW_NONINTERLEAVED
179674e95caSDavid Howells 
180674e95caSDavid Howells typedef int __bitwise snd_pcm_format_t;
181674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S8	((__force snd_pcm_format_t) 0)
182674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U8	((__force snd_pcm_format_t) 1)
183674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S16_LE	((__force snd_pcm_format_t) 2)
184674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S16_BE	((__force snd_pcm_format_t) 3)
185674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U16_LE	((__force snd_pcm_format_t) 4)
186674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U16_BE	((__force snd_pcm_format_t) 5)
187674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S24_LE	((__force snd_pcm_format_t) 6) /* low three bytes */
188674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S24_BE	((__force snd_pcm_format_t) 7) /* low three bytes */
189674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U24_LE	((__force snd_pcm_format_t) 8) /* low three bytes */
190674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U24_BE	((__force snd_pcm_format_t) 9) /* low three bytes */
19155b71f6cSTakashi Sakamoto /*
19255b71f6cSTakashi Sakamoto  * For S32/U32 formats, 'msbits' hardware parameter is often used to deliver information about the
19355b71f6cSTakashi Sakamoto  * available bit count in most significant bit. It's for the case of so-called 'left-justified' or
19455b71f6cSTakashi Sakamoto  * `right-padding` sample which has less width than 32 bit.
19555b71f6cSTakashi Sakamoto  */
196674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S32_LE	((__force snd_pcm_format_t) 10)
197674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S32_BE	((__force snd_pcm_format_t) 11)
198674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U32_LE	((__force snd_pcm_format_t) 12)
199674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U32_BE	((__force snd_pcm_format_t) 13)
200674e95caSDavid Howells #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 */
201674e95caSDavid Howells #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 */
202674e95caSDavid Howells #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 */
203674e95caSDavid Howells #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 */
204674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE ((__force snd_pcm_format_t) 18) /* IEC-958 subframe, Little Endian */
205674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE ((__force snd_pcm_format_t) 19) /* IEC-958 subframe, Big Endian */
206674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_MU_LAW		((__force snd_pcm_format_t) 20)
207674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_A_LAW		((__force snd_pcm_format_t) 21)
208674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_IMA_ADPCM	((__force snd_pcm_format_t) 22)
209674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_MPEG		((__force snd_pcm_format_t) 23)
210674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_GSM		((__force snd_pcm_format_t) 24)
211823dbb6eSMaciej S. Szmigiero #define	SNDRV_PCM_FORMAT_S20_LE	((__force snd_pcm_format_t) 25) /* in four bytes, LSB justified */
212823dbb6eSMaciej S. Szmigiero #define	SNDRV_PCM_FORMAT_S20_BE	((__force snd_pcm_format_t) 26) /* in four bytes, LSB justified */
213823dbb6eSMaciej S. Szmigiero #define	SNDRV_PCM_FORMAT_U20_LE	((__force snd_pcm_format_t) 27) /* in four bytes, LSB justified */
214823dbb6eSMaciej S. Szmigiero #define	SNDRV_PCM_FORMAT_U20_BE	((__force snd_pcm_format_t) 28) /* in four bytes, LSB justified */
215823dbb6eSMaciej S. Szmigiero /* gap in the numbering for a future standard linear format */
216674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_SPECIAL	((__force snd_pcm_format_t) 31)
217674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S24_3LE	((__force snd_pcm_format_t) 32)	/* in three bytes */
218674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S24_3BE	((__force snd_pcm_format_t) 33)	/* in three bytes */
219674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U24_3LE	((__force snd_pcm_format_t) 34)	/* in three bytes */
220674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U24_3BE	((__force snd_pcm_format_t) 35)	/* in three bytes */
221674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S20_3LE	((__force snd_pcm_format_t) 36)	/* in three bytes */
222674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S20_3BE	((__force snd_pcm_format_t) 37)	/* in three bytes */
223674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U20_3LE	((__force snd_pcm_format_t) 38)	/* in three bytes */
224674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U20_3BE	((__force snd_pcm_format_t) 39)	/* in three bytes */
225674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S18_3LE	((__force snd_pcm_format_t) 40)	/* in three bytes */
226674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S18_3BE	((__force snd_pcm_format_t) 41)	/* in three bytes */
227674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U18_3LE	((__force snd_pcm_format_t) 42)	/* in three bytes */
228674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U18_3BE	((__force snd_pcm_format_t) 43)	/* in three bytes */
229674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_G723_24	((__force snd_pcm_format_t) 44) /* 8 samples in 3 bytes */
230674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_G723_24_1B	((__force snd_pcm_format_t) 45) /* 1 sample in 1 byte */
231674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_G723_40	((__force snd_pcm_format_t) 46) /* 8 Samples in 5 bytes */
232674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_G723_40_1B	((__force snd_pcm_format_t) 47) /* 1 sample in 1 byte */
233ef7a4f97SDaniel Mack #define	SNDRV_PCM_FORMAT_DSD_U8		((__force snd_pcm_format_t) 48) /* DSD, 1-byte samples DSD (x8) */
234ef7a4f97SDaniel Mack #define	SNDRV_PCM_FORMAT_DSD_U16_LE	((__force snd_pcm_format_t) 49) /* DSD, 2-byte samples DSD (x16), little endian */
235d4288d3fSJurgen Kramer #define	SNDRV_PCM_FORMAT_DSD_U32_LE	((__force snd_pcm_format_t) 50) /* DSD, 4-byte samples DSD (x32), little endian */
236d42472ecSJussi Laako #define	SNDRV_PCM_FORMAT_DSD_U16_BE	((__force snd_pcm_format_t) 51) /* DSD, 2-byte samples DSD (x16), big endian */
237d42472ecSJussi Laako #define	SNDRV_PCM_FORMAT_DSD_U32_BE	((__force snd_pcm_format_t) 52) /* DSD, 4-byte samples DSD (x32), big endian */
238d42472ecSJussi Laako #define	SNDRV_PCM_FORMAT_LAST		SNDRV_PCM_FORMAT_DSD_U32_BE
2397ed310bdSFabio Estevam #define	SNDRV_PCM_FORMAT_FIRST		SNDRV_PCM_FORMAT_S8
240674e95caSDavid Howells 
241674e95caSDavid Howells #ifdef SNDRV_LITTLE_ENDIAN
242674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S16		SNDRV_PCM_FORMAT_S16_LE
243674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U16		SNDRV_PCM_FORMAT_U16_LE
244674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S24		SNDRV_PCM_FORMAT_S24_LE
245674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U24		SNDRV_PCM_FORMAT_U24_LE
246674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S32		SNDRV_PCM_FORMAT_S32_LE
247674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U32		SNDRV_PCM_FORMAT_U32_LE
248674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_FLOAT		SNDRV_PCM_FORMAT_FLOAT_LE
249674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_FLOAT64	SNDRV_PCM_FORMAT_FLOAT64_LE
250674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_IEC958_SUBFRAME SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE
251823dbb6eSMaciej S. Szmigiero #define	SNDRV_PCM_FORMAT_S20		SNDRV_PCM_FORMAT_S20_LE
252823dbb6eSMaciej S. Szmigiero #define	SNDRV_PCM_FORMAT_U20		SNDRV_PCM_FORMAT_U20_LE
253674e95caSDavid Howells #endif
254674e95caSDavid Howells #ifdef SNDRV_BIG_ENDIAN
255674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S16		SNDRV_PCM_FORMAT_S16_BE
256674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U16		SNDRV_PCM_FORMAT_U16_BE
257674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S24		SNDRV_PCM_FORMAT_S24_BE
258674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U24		SNDRV_PCM_FORMAT_U24_BE
259674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_S32		SNDRV_PCM_FORMAT_S32_BE
260674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_U32		SNDRV_PCM_FORMAT_U32_BE
261674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_FLOAT		SNDRV_PCM_FORMAT_FLOAT_BE
262674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_FLOAT64	SNDRV_PCM_FORMAT_FLOAT64_BE
263674e95caSDavid Howells #define	SNDRV_PCM_FORMAT_IEC958_SUBFRAME SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE
264823dbb6eSMaciej S. Szmigiero #define	SNDRV_PCM_FORMAT_S20		SNDRV_PCM_FORMAT_S20_BE
265823dbb6eSMaciej S. Szmigiero #define	SNDRV_PCM_FORMAT_U20		SNDRV_PCM_FORMAT_U20_BE
266674e95caSDavid Howells #endif
267674e95caSDavid Howells 
268674e95caSDavid Howells typedef int __bitwise snd_pcm_subformat_t;
269674e95caSDavid Howells #define	SNDRV_PCM_SUBFORMAT_STD		((__force snd_pcm_subformat_t) 0)
270674e95caSDavid Howells #define	SNDRV_PCM_SUBFORMAT_LAST	SNDRV_PCM_SUBFORMAT_STD
271674e95caSDavid Howells 
272674e95caSDavid Howells #define SNDRV_PCM_INFO_MMAP		0x00000001	/* hardware supports mmap */
273674e95caSDavid Howells #define SNDRV_PCM_INFO_MMAP_VALID	0x00000002	/* period data are valid during transfer */
274674e95caSDavid Howells #define SNDRV_PCM_INFO_DOUBLE		0x00000004	/* Double buffering needed for PCM start/stop */
275674e95caSDavid Howells #define SNDRV_PCM_INFO_BATCH		0x00000010	/* double buffering */
27642f94597STakashi Iwai #define SNDRV_PCM_INFO_SYNC_APPLPTR	0x00000020	/* need the explicit sync of appl_ptr update */
277674e95caSDavid Howells #define SNDRV_PCM_INFO_PERFECT_DRAIN	0x00000040	/* silencing at the end of stream is not required */
278674e95caSDavid Howells #define SNDRV_PCM_INFO_INTERLEAVED	0x00000100	/* channels are interleaved */
279674e95caSDavid Howells #define SNDRV_PCM_INFO_NONINTERLEAVED	0x00000200	/* channels are not interleaved */
280674e95caSDavid Howells #define SNDRV_PCM_INFO_COMPLEX		0x00000400	/* complex frame organization (mmap only) */
281674e95caSDavid Howells #define SNDRV_PCM_INFO_BLOCK_TRANSFER	0x00010000	/* hardware transfer block of samples */
282674e95caSDavid Howells #define SNDRV_PCM_INFO_OVERRANGE	0x00020000	/* hardware supports ADC (capture) overrange detection */
283674e95caSDavid Howells #define SNDRV_PCM_INFO_RESUME		0x00040000	/* hardware supports stream resume after suspend */
284674e95caSDavid Howells #define SNDRV_PCM_INFO_PAUSE		0x00080000	/* pause ioctl is supported */
285674e95caSDavid Howells #define SNDRV_PCM_INFO_HALF_DUPLEX	0x00100000	/* only half duplex */
286674e95caSDavid Howells #define SNDRV_PCM_INFO_JOINT_DUPLEX	0x00200000	/* playback and capture stream are somewhat correlated */
287674e95caSDavid Howells #define SNDRV_PCM_INFO_SYNC_START	0x00400000	/* pcm support some kind of sync go */
288229d0430SPierre-Louis Bossart #define SNDRV_PCM_INFO_NO_PERIOD_WAKEUP	0x00800000	/* period wakeup can be disabled */
289229d0430SPierre-Louis Bossart #define SNDRV_PCM_INFO_HAS_WALL_CLOCK   0x01000000      /* (Deprecated)has audio wall clock for audio/system time sync */
290229d0430SPierre-Louis Bossart #define SNDRV_PCM_INFO_HAS_LINK_ATIME              0x01000000  /* report hardware link audio time, reset on startup */
291229d0430SPierre-Louis Bossart #define SNDRV_PCM_INFO_HAS_LINK_ABSOLUTE_ATIME     0x02000000  /* report absolute hardware link audio time, not reset on startup */
292229d0430SPierre-Louis Bossart #define SNDRV_PCM_INFO_HAS_LINK_ESTIMATED_ATIME    0x04000000  /* report estimated link audio time */
29381be1093STakashi Iwai #define SNDRV_PCM_INFO_HAS_LINK_SYNCHRONIZED_ATIME 0x08000000  /* report synchronized audio/system time */
294b456abe6SPierre-Louis Bossart #define SNDRV_PCM_INFO_EXPLICIT_SYNC	0x10000000	/* needs explicit sync of pointers and data */
29548d88297SLibin Yang #define SNDRV_PCM_INFO_NO_REWINDS	0x20000000	/* hardware can only support monotonic changes of appl_ptr */
296674e95caSDavid Howells #define SNDRV_PCM_INFO_DRAIN_TRIGGER	0x40000000		/* internal kernel flag - trigger in drain */
297674e95caSDavid Howells #define SNDRV_PCM_INFO_FIFO_IN_FRAMES	0x80000000	/* internal kernel flag - FIFO size is in frames */
29880fe7430SArnd Bergmann 
29980fe7430SArnd Bergmann #if (__BITS_PER_LONG == 32 && defined(__USE_TIME_BITS64)) || defined __KERNEL__
30080fe7430SArnd Bergmann #define __SND_STRUCT_TIME64
301229d0430SPierre-Louis Bossart #endif
302674e95caSDavid Howells 
303674e95caSDavid Howells typedef int __bitwise snd_pcm_state_t;
304674e95caSDavid Howells #define	SNDRV_PCM_STATE_OPEN		((__force snd_pcm_state_t) 0) /* stream is open */
305674e95caSDavid Howells #define	SNDRV_PCM_STATE_SETUP		((__force snd_pcm_state_t) 1) /* stream has a setup */
306674e95caSDavid Howells #define	SNDRV_PCM_STATE_PREPARED	((__force snd_pcm_state_t) 2) /* stream is ready to start */
307674e95caSDavid Howells #define	SNDRV_PCM_STATE_RUNNING		((__force snd_pcm_state_t) 3) /* stream is running */
308674e95caSDavid Howells #define	SNDRV_PCM_STATE_XRUN		((__force snd_pcm_state_t) 4) /* stream reached an xrun */
309674e95caSDavid Howells #define	SNDRV_PCM_STATE_DRAINING	((__force snd_pcm_state_t) 5) /* stream is draining */
310674e95caSDavid Howells #define	SNDRV_PCM_STATE_PAUSED		((__force snd_pcm_state_t) 6) /* stream is paused */
311674e95caSDavid Howells #define	SNDRV_PCM_STATE_SUSPENDED	((__force snd_pcm_state_t) 7) /* hardware is suspended */
312674e95caSDavid Howells #define	SNDRV_PCM_STATE_DISCONNECTED	((__force snd_pcm_state_t) 8) /* hardware is disconnected */
313674e95caSDavid Howells #define	SNDRV_PCM_STATE_LAST		SNDRV_PCM_STATE_DISCONNECTED
314674e95caSDavid Howells 
315674e95caSDavid Howells enum {
31680fe7430SArnd Bergmann 	SNDRV_PCM_MMAP_OFFSET_DATA = 0x00000000,
31780fe7430SArnd Bergmann 	SNDRV_PCM_MMAP_OFFSET_STATUS_OLD = 0x80000000,
31880fe7430SArnd Bergmann 	SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD = 0x81000000,
31980fe7430SArnd Bergmann 	SNDRV_PCM_MMAP_OFFSET_STATUS_NEW = 0x82000000,
32080fe7430SArnd Bergmann 	SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW = 0x83000000,
32180fe7430SArnd Bergmann #ifdef __SND_STRUCT_TIME64
32280fe7430SArnd Bergmann 	SNDRV_PCM_MMAP_OFFSET_STATUS = SNDRV_PCM_MMAP_OFFSET_STATUS_NEW,
32380fe7430SArnd Bergmann 	SNDRV_PCM_MMAP_OFFSET_CONTROL = SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW,
32480fe7430SArnd Bergmann #else
32580fe7430SArnd Bergmann 	SNDRV_PCM_MMAP_OFFSET_STATUS = SNDRV_PCM_MMAP_OFFSET_STATUS_OLD,
32680fe7430SArnd Bergmann 	SNDRV_PCM_MMAP_OFFSET_CONTROL = SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD,
327674e95caSDavid Howells #endif
328674e95caSDavid Howells };
329674e95caSDavid Howells 
330674e95caSDavid Howells union snd_pcm_sync_id {
331674e95caSDavid Howells 	unsigned char id[16];
332674e95caSDavid Howells 	unsigned short id16[8];
333674e95caSDavid Howells 	unsigned int id32[4];
334674e95caSDavid Howells };
335674e95caSDavid Howells 
336674e95caSDavid Howells struct snd_pcm_info {
337674e95caSDavid Howells 	unsigned int device;		/* RO/WR (control): device number */
338674e95caSDavid Howells 	unsigned int subdevice;		/* RO/WR (control): subdevice number */
339674e95caSDavid Howells 	int stream;			/* RO/WR (control): stream direction */
340674e95caSDavid Howells 	int card;			/* R: card number */
341674e95caSDavid Howells 	unsigned char id[64];		/* ID (user selectable) */
342674e95caSDavid Howells 	unsigned char name[80];		/* name of this device */
343674e95caSDavid Howells 	unsigned char subname[32];	/* subdevice name */
344674e95caSDavid Howells 	int dev_class;			/* SNDRV_PCM_CLASS_* */
345674e95caSDavid Howells 	int dev_subclass;		/* SNDRV_PCM_SUBCLASS_* */
346674e95caSDavid Howells 	unsigned int subdevices_count;
347674e95caSDavid Howells 	unsigned int subdevices_avail;
348674e95caSDavid Howells 	union snd_pcm_sync_id sync;	/* hardware synchronization ID */
349674e95caSDavid Howells 	unsigned char reserved[64];	/* reserved for future... */
350674e95caSDavid Howells };
351674e95caSDavid Howells 
352674e95caSDavid Howells typedef int snd_pcm_hw_param_t;
353674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_ACCESS	0	/* Access type */
354674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_FORMAT	1	/* Format */
355674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_SUBFORMAT	2	/* Subformat */
356674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_FIRST_MASK	SNDRV_PCM_HW_PARAM_ACCESS
357674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_LAST_MASK	SNDRV_PCM_HW_PARAM_SUBFORMAT
358674e95caSDavid Howells 
359674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_SAMPLE_BITS	8	/* Bits per sample */
360674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_FRAME_BITS	9	/* Bits per frame */
361674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_CHANNELS	10	/* Channels */
362674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_RATE		11	/* Approx rate */
363674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_PERIOD_TIME	12	/* Approx distance between
364674e95caSDavid Howells 						 * interrupts in us
365674e95caSDavid Howells 						 */
366674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_PERIOD_SIZE	13	/* Approx frames between
367674e95caSDavid Howells 						 * interrupts
368674e95caSDavid Howells 						 */
369674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_PERIOD_BYTES	14	/* Approx bytes between
370674e95caSDavid Howells 						 * interrupts
371674e95caSDavid Howells 						 */
372674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_PERIODS	15	/* Approx interrupts per
373674e95caSDavid Howells 						 * buffer
374674e95caSDavid Howells 						 */
375674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_BUFFER_TIME	16	/* Approx duration of buffer
376674e95caSDavid Howells 						 * in us
377674e95caSDavid Howells 						 */
378674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_BUFFER_SIZE	17	/* Size of buffer in frames */
379674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_BUFFER_BYTES	18	/* Size of buffer in bytes */
380674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_TICK_TIME	19	/* Approx tick duration in us */
381674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_FIRST_INTERVAL	SNDRV_PCM_HW_PARAM_SAMPLE_BITS
382674e95caSDavid Howells #define	SNDRV_PCM_HW_PARAM_LAST_INTERVAL	SNDRV_PCM_HW_PARAM_TICK_TIME
383674e95caSDavid Howells 
384674e95caSDavid Howells #define SNDRV_PCM_HW_PARAMS_NORESAMPLE	(1<<0)	/* avoid rate resampling */
385674e95caSDavid Howells #define SNDRV_PCM_HW_PARAMS_EXPORT_BUFFER	(1<<1)	/* export buffer */
386674e95caSDavid Howells #define SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP	(1<<2)	/* disable period wakeups */
387674e95caSDavid Howells #define SNDRV_PCM_HW_PARAMS_NO_DRAIN_SILENCE	(1<<3)	/* suppress drain with the filling
388674e95caSDavid Howells 							 * of the silence samples
389674e95caSDavid Howells 							 */
390674e95caSDavid Howells 
391674e95caSDavid Howells struct snd_interval {
392674e95caSDavid Howells 	unsigned int min, max;
393674e95caSDavid Howells 	unsigned int openmin:1,
394674e95caSDavid Howells 		     openmax:1,
395674e95caSDavid Howells 		     integer:1,
396674e95caSDavid Howells 		     empty:1;
397674e95caSDavid Howells };
398674e95caSDavid Howells 
399674e95caSDavid Howells #define SNDRV_MASK_MAX	256
400674e95caSDavid Howells 
401674e95caSDavid Howells struct snd_mask {
402674e95caSDavid Howells 	__u32 bits[(SNDRV_MASK_MAX+31)/32];
403674e95caSDavid Howells };
404674e95caSDavid Howells 
405674e95caSDavid Howells struct snd_pcm_hw_params {
406674e95caSDavid Howells 	unsigned int flags;
407674e95caSDavid Howells 	struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
408674e95caSDavid Howells 			       SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
409674e95caSDavid Howells 	struct snd_mask mres[5];	/* reserved masks */
410674e95caSDavid Howells 	struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
411674e95caSDavid Howells 				        SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
412674e95caSDavid Howells 	struct snd_interval ires[9];	/* reserved intervals */
413674e95caSDavid Howells 	unsigned int rmask;		/* W: requested masks */
414674e95caSDavid Howells 	unsigned int cmask;		/* R: changed masks */
415674e95caSDavid Howells 	unsigned int info;		/* R: Info flags for returned setup */
416674e95caSDavid Howells 	unsigned int msbits;		/* R: used most significant bits */
417674e95caSDavid Howells 	unsigned int rate_num;		/* R: rate numerator */
418674e95caSDavid Howells 	unsigned int rate_den;		/* R: rate denominator */
419674e95caSDavid Howells 	snd_pcm_uframes_t fifo_size;	/* R: chip FIFO size in frames */
420674e95caSDavid Howells 	unsigned char reserved[64];	/* reserved for future */
421674e95caSDavid Howells };
422674e95caSDavid Howells 
423674e95caSDavid Howells enum {
424674e95caSDavid Howells 	SNDRV_PCM_TSTAMP_NONE = 0,
425674e95caSDavid Howells 	SNDRV_PCM_TSTAMP_ENABLE,
426674e95caSDavid Howells 	SNDRV_PCM_TSTAMP_LAST = SNDRV_PCM_TSTAMP_ENABLE,
427674e95caSDavid Howells };
428674e95caSDavid Howells 
429674e95caSDavid Howells struct snd_pcm_sw_params {
430674e95caSDavid Howells 	int tstamp_mode;			/* timestamp mode */
431674e95caSDavid Howells 	unsigned int period_step;
4329f656705SOswald Buddenhagen 	unsigned int sleep_min;			/* min ticks to sleep */
4339f656705SOswald Buddenhagen 	snd_pcm_uframes_t avail_min;		/* min avail frames for wakeup */
4349f656705SOswald Buddenhagen 	snd_pcm_uframes_t xfer_align;		/* obsolete: xfer size need to be a multiple */
4359f656705SOswald Buddenhagen 	snd_pcm_uframes_t start_threshold;	/* min hw_avail frames for automatic start */
4369f656705SOswald Buddenhagen 	/*
4379f656705SOswald Buddenhagen 	 * The following two thresholds alleviate playback buffer underruns; when
4389f656705SOswald Buddenhagen 	 * hw_avail drops below the threshold, the respective action is triggered:
4399f656705SOswald Buddenhagen 	 */
440674e95caSDavid Howells 	snd_pcm_uframes_t stop_threshold;	/* - stop playback */
44158900810STakashi Iwai 	snd_pcm_uframes_t silence_threshold;	/* - pre-fill buffer with silence */
44258900810STakashi Iwai 	snd_pcm_uframes_t silence_size;		/* max size of silence pre-fill; when >= boundary,
4435646eda5STakashi Iwai 						 * fill played area with silence immediately */
444674e95caSDavid Howells 	snd_pcm_uframes_t boundary;		/* pointers wrap point */
445674e95caSDavid Howells 	unsigned int proto;			/* protocol version */
446674e95caSDavid Howells 	unsigned int tstamp_type;		/* timestamp type (req. proto >= 2.0.12) */
447674e95caSDavid Howells 	unsigned char reserved[56];		/* reserved for future */
448674e95caSDavid Howells };
449674e95caSDavid Howells 
450674e95caSDavid Howells struct snd_pcm_channel_info {
451674e95caSDavid Howells 	unsigned int channel;
452674e95caSDavid Howells 	__kernel_off_t offset;		/* mmap offset */
453229d0430SPierre-Louis Bossart 	unsigned int first;		/* offset to first sample in bits */
454229d0430SPierre-Louis Bossart 	unsigned int step;		/* samples distance in bits */
455229d0430SPierre-Louis Bossart };
456229d0430SPierre-Louis Bossart 
457229d0430SPierre-Louis Bossart enum {
458229d0430SPierre-Louis Bossart 	/*
459229d0430SPierre-Louis Bossart 	 *  first definition for backwards compatibility only,
460229d0430SPierre-Louis Bossart 	 *  maps to wallclock/link time for HDAudio playback and DEFAULT/DMA time for everything else
461229d0430SPierre-Louis Bossart 	 */
462229d0430SPierre-Louis Bossart 	SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT = 0,
463229d0430SPierre-Louis Bossart 
464229d0430SPierre-Louis Bossart 	/* timestamp definitions */
465229d0430SPierre-Louis Bossart 	SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT = 1,           /* DMA time, reported as per hw_ptr */
466229d0430SPierre-Louis Bossart 	SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK = 2,	           /* link time reported by sample or wallclock counter, reset on startup */
467229d0430SPierre-Louis Bossart 	SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_ABSOLUTE = 3,	   /* link time reported by sample or wallclock counter, not reset on startup */
468229d0430SPierre-Louis Bossart 	SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_ESTIMATED = 4,    /* link time estimated indirectly */
4693ddee7f8SBaolin Wang 	SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_SYNCHRONIZED = 5, /* link time synchronized with system time */
4703ddee7f8SBaolin Wang 	SNDRV_PCM_AUDIO_TSTAMP_TYPE_LAST = SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK_SYNCHRONIZED
4717fd7d6c5STakashi Iwai };
4723ddee7f8SBaolin Wang 
473674e95caSDavid Howells #ifndef __KERNEL__
474674e95caSDavid Howells /* explicit padding avoids incompatibility between i386 and x86-64 */
4753ddee7f8SBaolin Wang typedef struct { unsigned char pad[sizeof(time_t) - sizeof(int)]; } __time_pad;
476674e95caSDavid Howells 
477674e95caSDavid Howells struct snd_pcm_status {
478674e95caSDavid Howells 	snd_pcm_state_t state;		/* stream state */
479674e95caSDavid Howells 	__time_pad pad1;		/* align to timespec */
480674e95caSDavid Howells 	struct timespec trigger_tstamp;	/* time when stream was started/stopped/paused */
481674e95caSDavid Howells 	struct timespec tstamp;		/* reference timestamp */
482674e95caSDavid Howells 	snd_pcm_uframes_t appl_ptr;	/* appl ptr */
483674e95caSDavid Howells 	snd_pcm_uframes_t hw_ptr;	/* hw ptr */
484674e95caSDavid Howells 	snd_pcm_sframes_t delay;	/* current delay in frames */
485229d0430SPierre-Louis Bossart 	snd_pcm_uframes_t avail;	/* number of frames available */
486229d0430SPierre-Louis Bossart 	snd_pcm_uframes_t avail_max;	/* max frames available on hw since last status */
487229d0430SPierre-Louis Bossart 	snd_pcm_uframes_t overrange;	/* count of ADC (capture) overrange detections from last status */
488229d0430SPierre-Louis Bossart 	snd_pcm_state_t suspended_state; /* suspended stream state */
489229d0430SPierre-Louis Bossart 	__u32 audio_tstamp_data;	 /* needed for 64-bit alignment, used for configs/report to/from userspace */
490674e95caSDavid Howells 	struct timespec audio_tstamp;	/* sample counter, wall clock, PHC or on-demand sync'ed */
4913ddee7f8SBaolin Wang 	struct timespec driver_tstamp;	/* useful in case reference system tstamp is reported with delay */
492674e95caSDavid Howells 	__u32 audio_tstamp_accuracy;	/* in ns units, only valid if indicated in audio_tstamp_data */
49380fe7430SArnd Bergmann 	unsigned char reserved[52-2*sizeof(struct timespec)]; /* must be filled with zero */
49480fe7430SArnd Bergmann };
49580fe7430SArnd Bergmann #endif
49680fe7430SArnd Bergmann 
49780fe7430SArnd Bergmann /*
49880fe7430SArnd Bergmann  * For mmap operations, we need the 64-bit layout, both for compat mode,
49980fe7430SArnd Bergmann  * and for y2038 compatibility. For 64-bit applications, the two definitions
50080fe7430SArnd Bergmann  * are identical, so we keep the traditional version.
50180fe7430SArnd Bergmann  */
50280fe7430SArnd Bergmann #ifdef __SND_STRUCT_TIME64
50380fe7430SArnd Bergmann #define __snd_pcm_mmap_status64		snd_pcm_mmap_status
50480fe7430SArnd Bergmann #define __snd_pcm_mmap_control64	snd_pcm_mmap_control
50580fe7430SArnd Bergmann #define __snd_pcm_sync_ptr64		snd_pcm_sync_ptr
50680fe7430SArnd Bergmann #ifdef __KERNEL__
50780fe7430SArnd Bergmann #define __snd_timespec64		__kernel_timespec
50880fe7430SArnd Bergmann #else
50980fe7430SArnd Bergmann #define __snd_timespec64		timespec
51080fe7430SArnd Bergmann #endif
51180fe7430SArnd Bergmann struct __snd_timespec {
51280fe7430SArnd Bergmann 	__s32 tv_sec;
51380fe7430SArnd Bergmann 	__s32 tv_nsec;
51480fe7430SArnd Bergmann };
51580fe7430SArnd Bergmann #else
51680fe7430SArnd Bergmann #define __snd_pcm_mmap_status		snd_pcm_mmap_status
51780fe7430SArnd Bergmann #define __snd_pcm_mmap_control		snd_pcm_mmap_control
51880fe7430SArnd Bergmann #define __snd_pcm_sync_ptr		snd_pcm_sync_ptr
51980fe7430SArnd Bergmann #define __snd_timespec			timespec
52080fe7430SArnd Bergmann struct __snd_timespec64 {
52180fe7430SArnd Bergmann 	__s64 tv_sec;
52280fe7430SArnd Bergmann 	__s64 tv_nsec;
52380fe7430SArnd Bergmann };
524674e95caSDavid Howells 
525674e95caSDavid Howells #endif
526674e95caSDavid Howells 
52780fe7430SArnd Bergmann struct __snd_pcm_mmap_status {
528674e95caSDavid Howells 	snd_pcm_state_t state;		/* RO: state - SNDRV_PCM_STATE_XXXX */
52980fe7430SArnd Bergmann 	int pad1;			/* Needed for 64 bit alignment */
530674e95caSDavid Howells 	snd_pcm_uframes_t hw_ptr;	/* RO: hw ptr (0...boundary-1) */
531674e95caSDavid Howells 	struct __snd_timespec tstamp;	/* Timestamp */
53280fe7430SArnd Bergmann 	snd_pcm_state_t suspended_state; /* RO: suspended stream state */
533674e95caSDavid Howells 	struct __snd_timespec audio_tstamp; /* from sample counter or wall clock */
534674e95caSDavid Howells };
535674e95caSDavid Howells 
536674e95caSDavid Howells struct __snd_pcm_mmap_control {
537674e95caSDavid Howells 	snd_pcm_uframes_t appl_ptr;	/* RW: appl ptr (0...boundary-1) */
538674e95caSDavid Howells 	snd_pcm_uframes_t avail_min;	/* RW: min available frames for wakeup */
539674e95caSDavid Howells };
540674e95caSDavid Howells 
54180fe7430SArnd Bergmann #define SNDRV_PCM_SYNC_PTR_HWSYNC	(1<<0)	/* execute hwsync */
542674e95caSDavid Howells #define SNDRV_PCM_SYNC_PTR_APPL		(1<<1)	/* get appl_ptr from driver (r/w op) */
543674e95caSDavid Howells #define SNDRV_PCM_SYNC_PTR_AVAIL_MIN	(1<<2)	/* get avail_min from driver */
54480fe7430SArnd Bergmann 
545674e95caSDavid Howells struct __snd_pcm_sync_ptr {
546674e95caSDavid Howells 	unsigned int flags;
547674e95caSDavid Howells 	union {
54880fe7430SArnd Bergmann 		struct __snd_pcm_mmap_status status;
54980fe7430SArnd Bergmann 		unsigned char reserved[64];
55080fe7430SArnd Bergmann 	} s;
55180fe7430SArnd Bergmann 	union {
55280fe7430SArnd Bergmann 		struct __snd_pcm_mmap_control control;
55380fe7430SArnd Bergmann 		unsigned char reserved[64];
55480fe7430SArnd Bergmann 	} c;
55580fe7430SArnd Bergmann };
55680fe7430SArnd Bergmann 
55780fe7430SArnd Bergmann #if defined(__BYTE_ORDER) ? __BYTE_ORDER == __BIG_ENDIAN : defined(__BIG_ENDIAN)
55880fe7430SArnd Bergmann typedef char __pad_before_uframe[sizeof(__u64) - sizeof(snd_pcm_uframes_t)];
55980fe7430SArnd Bergmann typedef char __pad_after_uframe[0];
56080fe7430SArnd Bergmann #endif
56180fe7430SArnd Bergmann 
56280fe7430SArnd Bergmann #if defined(__BYTE_ORDER) ? __BYTE_ORDER == __LITTLE_ENDIAN : defined(__LITTLE_ENDIAN)
56380fe7430SArnd Bergmann typedef char __pad_before_uframe[0];
56446b770f7SRanjani Sridharan typedef char __pad_after_uframe[sizeof(__u64) - sizeof(snd_pcm_uframes_t)];
56580fe7430SArnd Bergmann #endif
56680fe7430SArnd Bergmann 
56780fe7430SArnd Bergmann struct __snd_pcm_mmap_status64 {
56880fe7430SArnd Bergmann 	snd_pcm_state_t state;		/* RO: state - SNDRV_PCM_STATE_XXXX */
56980fe7430SArnd Bergmann 	__u32 pad1;			/* Needed for 64 bit alignment */
57046b770f7SRanjani Sridharan 	__pad_before_uframe __pad1;
57180fe7430SArnd Bergmann 	snd_pcm_uframes_t hw_ptr;	/* RO: hw ptr (0...boundary-1) */
57280fe7430SArnd Bergmann 	__pad_after_uframe __pad2;
57380fe7430SArnd Bergmann 	struct __snd_timespec64 tstamp;	/* Timestamp */
57480fe7430SArnd Bergmann 	snd_pcm_state_t suspended_state;/* RO: suspended stream state */
57580fe7430SArnd Bergmann 	__u32 pad3;			/* Needed for 64 bit alignment */
57680fe7430SArnd Bergmann 	struct __snd_timespec64 audio_tstamp; /* sample counter or wall clock */
57780fe7430SArnd Bergmann };
578102882b5SOswald Buddenhagen 
579102882b5SOswald Buddenhagen struct __snd_pcm_mmap_control64 {
58080fe7430SArnd Bergmann 	__pad_before_uframe __pad1;
58180fe7430SArnd Bergmann 	snd_pcm_uframes_t appl_ptr;	 /* RW: appl ptr (0...boundary-1) */
58280fe7430SArnd Bergmann 	__pad_before_uframe __pad2;	 // This should be __pad_after_uframe, but binary
58380fe7430SArnd Bergmann 					 // backwards compatibility constraints prevent a fix.
58480fe7430SArnd Bergmann 
58580fe7430SArnd Bergmann 	__pad_before_uframe __pad3;
58680fe7430SArnd Bergmann 	snd_pcm_uframes_t  avail_min;	 /* RW: min available frames for wakeup */
58780fe7430SArnd Bergmann 	__pad_after_uframe __pad4;
58880fe7430SArnd Bergmann };
58980fe7430SArnd Bergmann 
59080fe7430SArnd Bergmann struct __snd_pcm_sync_ptr64 {
59180fe7430SArnd Bergmann 	__u32 flags;
59280fe7430SArnd Bergmann 	__u32 pad1;
59380fe7430SArnd Bergmann 	union {
59480fe7430SArnd Bergmann 		struct __snd_pcm_mmap_status64 status;
595674e95caSDavid Howells 		unsigned char reserved[64];
596674e95caSDavid Howells 	} s;
597674e95caSDavid Howells 	union {
598674e95caSDavid Howells 		struct __snd_pcm_mmap_control64 control;
599674e95caSDavid Howells 		unsigned char reserved[64];
600674e95caSDavid Howells 	} c;
601674e95caSDavid Howells };
602674e95caSDavid Howells 
603674e95caSDavid Howells struct snd_xferi {
604674e95caSDavid Howells 	snd_pcm_sframes_t result;
605674e95caSDavid Howells 	void __user *buf;
606674e95caSDavid Howells 	snd_pcm_uframes_t frames;
607674e95caSDavid Howells };
608674e95caSDavid Howells 
609674e95caSDavid Howells struct snd_xfern {
610674e95caSDavid Howells 	snd_pcm_sframes_t result;
611674e95caSDavid Howells 	void __user * __user *bufs;
612674e95caSDavid Howells 	snd_pcm_uframes_t frames;
613674e95caSDavid Howells };
6140ac8a52dSMark Brown 
6150ac8a52dSMark Brown enum {
616674e95caSDavid Howells 	SNDRV_PCM_TSTAMP_TYPE_GETTIMEOFDAY = 0,	/* gettimeofday equivalent */
617674e95caSDavid Howells 	SNDRV_PCM_TSTAMP_TYPE_MONOTONIC,	/* posix_clock_monotonic equivalent */
618674e95caSDavid Howells 	SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW,    /* monotonic_raw (no NTP) */
619674e95caSDavid Howells 	SNDRV_PCM_TSTAMP_TYPE_LAST = SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW,
620674e95caSDavid Howells };
621674e95caSDavid Howells 
622674e95caSDavid Howells /* channel positions */
623674e95caSDavid Howells enum {
624674e95caSDavid Howells 	SNDRV_CHMAP_UNKNOWN = 0,
625674e95caSDavid Howells 	SNDRV_CHMAP_NA,		/* N/A, silent */
626674e95caSDavid Howells 	SNDRV_CHMAP_MONO,	/* mono stream */
627674e95caSDavid Howells 	/* this follows the alsa-lib mixer channel value + 3 */
628674e95caSDavid Howells 	SNDRV_CHMAP_FL,		/* front left */
629674e95caSDavid Howells 	SNDRV_CHMAP_FR,		/* front right */
630674e95caSDavid Howells 	SNDRV_CHMAP_RL,		/* rear left */
631674e95caSDavid Howells 	SNDRV_CHMAP_RR,		/* rear right */
632674e95caSDavid Howells 	SNDRV_CHMAP_FC,		/* front center */
633674e95caSDavid Howells 	SNDRV_CHMAP_LFE,	/* LFE */
634674e95caSDavid Howells 	SNDRV_CHMAP_SL,		/* side left */
635674e95caSDavid Howells 	SNDRV_CHMAP_SR,		/* side right */
636674e95caSDavid Howells 	SNDRV_CHMAP_RC,		/* rear center */
637674e95caSDavid Howells 	/* new definitions */
638674e95caSDavid Howells 	SNDRV_CHMAP_FLC,	/* front left center */
639674e95caSDavid Howells 	SNDRV_CHMAP_FRC,	/* front right center */
640674e95caSDavid Howells 	SNDRV_CHMAP_RLC,	/* rear left center */
641674e95caSDavid Howells 	SNDRV_CHMAP_RRC,	/* rear right center */
642674e95caSDavid Howells 	SNDRV_CHMAP_FLW,	/* front left wide */
643674e95caSDavid Howells 	SNDRV_CHMAP_FRW,	/* front right wide */
644674e95caSDavid Howells 	SNDRV_CHMAP_FLH,	/* front left high */
645674e95caSDavid Howells 	SNDRV_CHMAP_FCH,	/* front center high */
646674e95caSDavid Howells 	SNDRV_CHMAP_FRH,	/* front right high */
647674e95caSDavid Howells 	SNDRV_CHMAP_TC,		/* top center */
648674e95caSDavid Howells 	SNDRV_CHMAP_TFL,	/* top front left */
649674e95caSDavid Howells 	SNDRV_CHMAP_TFR,	/* top front right */
6507cc17a31STakashi Iwai 	SNDRV_CHMAP_TFC,	/* top front center */
6517cc17a31STakashi Iwai 	SNDRV_CHMAP_TRL,	/* top rear left */
6527cc17a31STakashi Iwai 	SNDRV_CHMAP_TRR,	/* top rear right */
6537cc17a31STakashi Iwai 	SNDRV_CHMAP_TRC,	/* top rear center */
6547cc17a31STakashi Iwai 	/* new definitions for UAC2 */
6557cc17a31STakashi Iwai 	SNDRV_CHMAP_TFLC,	/* top front left center */
6567cc17a31STakashi Iwai 	SNDRV_CHMAP_TFRC,	/* top front right center */
6577cc17a31STakashi Iwai 	SNDRV_CHMAP_TSL,	/* top side left */
6587cc17a31STakashi Iwai 	SNDRV_CHMAP_TSR,	/* top side right */
6597cc17a31STakashi Iwai 	SNDRV_CHMAP_LLFE,	/* left LFE */
6607cc17a31STakashi Iwai 	SNDRV_CHMAP_RLFE,	/* right LFE */
661674e95caSDavid Howells 	SNDRV_CHMAP_BC,		/* bottom center */
662674e95caSDavid Howells 	SNDRV_CHMAP_BLC,	/* bottom left center */
663674e95caSDavid Howells 	SNDRV_CHMAP_BRC,	/* bottom right center */
664674e95caSDavid Howells 	SNDRV_CHMAP_LAST = SNDRV_CHMAP_BRC,
665674e95caSDavid Howells };
666674e95caSDavid Howells 
667674e95caSDavid Howells #define SNDRV_CHMAP_POSITION_MASK	0xffff
668674e95caSDavid Howells #define SNDRV_CHMAP_PHASE_INVERSE	(0x01 << 16)
669674e95caSDavid Howells #define SNDRV_CHMAP_DRIVER_SPEC		(0x02 << 16)
670674e95caSDavid Howells 
6714b671f57STakashi Iwai #define SNDRV_PCM_IOCTL_PVERSION	_IOR('A', 0x00, int)
672674e95caSDavid Howells #define SNDRV_PCM_IOCTL_INFO		_IOR('A', 0x01, struct snd_pcm_info)
673674e95caSDavid Howells #define SNDRV_PCM_IOCTL_TSTAMP		_IOW('A', 0x02, int)
674674e95caSDavid Howells #define SNDRV_PCM_IOCTL_TTSTAMP		_IOW('A', 0x03, int)
675674e95caSDavid Howells #define SNDRV_PCM_IOCTL_USER_PVERSION	_IOW('A', 0x04, int)
676674e95caSDavid Howells #define SNDRV_PCM_IOCTL_HW_REFINE	_IOWR('A', 0x10, struct snd_pcm_hw_params)
677674e95caSDavid Howells #define SNDRV_PCM_IOCTL_HW_PARAMS	_IOWR('A', 0x11, struct snd_pcm_hw_params)
678674e95caSDavid Howells #define SNDRV_PCM_IOCTL_HW_FREE		_IO('A', 0x12)
67980fe7430SArnd Bergmann #define SNDRV_PCM_IOCTL_SW_PARAMS	_IOWR('A', 0x13, struct snd_pcm_sw_params)
68080fe7430SArnd Bergmann #define SNDRV_PCM_IOCTL_STATUS		_IOR('A', 0x20, struct snd_pcm_status)
681674e95caSDavid Howells #define SNDRV_PCM_IOCTL_DELAY		_IOR('A', 0x21, snd_pcm_sframes_t)
682229d0430SPierre-Louis Bossart #define SNDRV_PCM_IOCTL_HWSYNC		_IO('A', 0x22)
683674e95caSDavid Howells #define __SNDRV_PCM_IOCTL_SYNC_PTR	_IOWR('A', 0x23, struct __snd_pcm_sync_ptr)
684674e95caSDavid Howells #define __SNDRV_PCM_IOCTL_SYNC_PTR64	_IOWR('A', 0x23, struct __snd_pcm_sync_ptr64)
685674e95caSDavid Howells #define SNDRV_PCM_IOCTL_SYNC_PTR	_IOWR('A', 0x23, struct snd_pcm_sync_ptr)
686674e95caSDavid Howells #define SNDRV_PCM_IOCTL_STATUS_EXT	_IOWR('A', 0x24, struct snd_pcm_status)
687674e95caSDavid Howells #define SNDRV_PCM_IOCTL_CHANNEL_INFO	_IOR('A', 0x32, struct snd_pcm_channel_info)
688674e95caSDavid Howells #define SNDRV_PCM_IOCTL_PREPARE		_IO('A', 0x40)
689674e95caSDavid Howells #define SNDRV_PCM_IOCTL_RESET		_IO('A', 0x41)
690674e95caSDavid Howells #define SNDRV_PCM_IOCTL_START		_IO('A', 0x42)
691674e95caSDavid Howells #define SNDRV_PCM_IOCTL_DROP		_IO('A', 0x43)
692674e95caSDavid Howells #define SNDRV_PCM_IOCTL_DRAIN		_IO('A', 0x44)
693674e95caSDavid Howells #define SNDRV_PCM_IOCTL_PAUSE		_IOW('A', 0x45, int)
694674e95caSDavid Howells #define SNDRV_PCM_IOCTL_REWIND		_IOW('A', 0x46, snd_pcm_uframes_t)
695674e95caSDavid Howells #define SNDRV_PCM_IOCTL_RESUME		_IO('A', 0x47)
696674e95caSDavid Howells #define SNDRV_PCM_IOCTL_XRUN		_IO('A', 0x48)
697674e95caSDavid Howells #define SNDRV_PCM_IOCTL_FORWARD		_IOW('A', 0x49, snd_pcm_uframes_t)
698674e95caSDavid Howells #define SNDRV_PCM_IOCTL_WRITEI_FRAMES	_IOW('A', 0x50, struct snd_xferi)
699674e95caSDavid Howells #define SNDRV_PCM_IOCTL_READI_FRAMES	_IOR('A', 0x51, struct snd_xferi)
700674e95caSDavid Howells #define SNDRV_PCM_IOCTL_WRITEN_FRAMES	_IOW('A', 0x52, struct snd_xfern)
701674e95caSDavid Howells #define SNDRV_PCM_IOCTL_READN_FRAMES	_IOR('A', 0x53, struct snd_xfern)
702674e95caSDavid Howells #define SNDRV_PCM_IOCTL_LINK		_IOW('A', 0x60, int)
703674e95caSDavid Howells #define SNDRV_PCM_IOCTL_UNLINK		_IO('A', 0x61)
704674e95caSDavid Howells 
705674e95caSDavid Howells /*****************************************************************************
706674e95caSDavid Howells  *                                                                           *
707674e95caSDavid Howells  *                            MIDI v1.0 interface                            *
708674e95caSDavid Howells  *                                                                           *
709674e95caSDavid Howells  *****************************************************************************/
710674e95caSDavid Howells 
711e375b8a0STakashi Iwai /*
712674e95caSDavid Howells  *  Raw MIDI section - /dev/snd/midi??
713674e95caSDavid Howells  */
714674e95caSDavid Howells 
715674e95caSDavid Howells #define SNDRV_RAWMIDI_VERSION		SNDRV_PROTOCOL_VERSION(2, 0, 4)
716674e95caSDavid Howells 
717674e95caSDavid Howells enum {
718674e95caSDavid Howells 	SNDRV_RAWMIDI_STREAM_OUTPUT = 0,
719674e95caSDavid Howells 	SNDRV_RAWMIDI_STREAM_INPUT,
720674e95caSDavid Howells 	SNDRV_RAWMIDI_STREAM_LAST = SNDRV_RAWMIDI_STREAM_INPUT,
721674e95caSDavid Howells };
722e3a8a5b7STakashi Iwai 
723674e95caSDavid Howells #define SNDRV_RAWMIDI_INFO_OUTPUT		0x00000001
724674e95caSDavid Howells #define SNDRV_RAWMIDI_INFO_INPUT		0x00000002
725674e95caSDavid Howells #define SNDRV_RAWMIDI_INFO_DUPLEX		0x00000004
726674e95caSDavid Howells #define SNDRV_RAWMIDI_INFO_UMP			0x00000008
727674e95caSDavid Howells 
728674e95caSDavid Howells struct snd_rawmidi_info {
729674e95caSDavid Howells 	unsigned int device;		/* RO/WR (control): device number */
730674e95caSDavid Howells 	unsigned int subdevice;		/* RO/WR (control): subdevice number */
731674e95caSDavid Howells 	int stream;			/* WR: stream */
732674e95caSDavid Howells 	int card;			/* R: card number */
733674e95caSDavid Howells 	unsigned int flags;		/* SNDRV_RAWMIDI_INFO_XXXX */
734674e95caSDavid Howells 	unsigned char id[64];		/* ID (user selectable) */
735674e95caSDavid Howells 	unsigned char name[80];		/* name of device */
736674e95caSDavid Howells 	unsigned char subname[32];	/* name of active or selected subdevice */
737674e95caSDavid Howells 	unsigned int subdevices_count;
73808fdced6SDavid Henningsson 	unsigned int subdevices_avail;
73908fdced6SDavid Henningsson 	unsigned char reserved[64];	/* reserved for future use */
74008fdced6SDavid Henningsson };
74108fdced6SDavid Henningsson 
74208fdced6SDavid Henningsson #define SNDRV_RAWMIDI_MODE_FRAMING_MASK		(7<<0)
74308fdced6SDavid Henningsson #define SNDRV_RAWMIDI_MODE_FRAMING_SHIFT	0
74408fdced6SDavid Henningsson #define SNDRV_RAWMIDI_MODE_FRAMING_NONE		(0<<0)
74508fdced6SDavid Henningsson #define SNDRV_RAWMIDI_MODE_FRAMING_TSTAMP	(1<<0)
74608fdced6SDavid Henningsson #define SNDRV_RAWMIDI_MODE_CLOCK_MASK		(7<<3)
74708fdced6SDavid Henningsson #define SNDRV_RAWMIDI_MODE_CLOCK_SHIFT		3
74808fdced6SDavid Henningsson #define SNDRV_RAWMIDI_MODE_CLOCK_NONE		(0<<3)
74908fdced6SDavid Henningsson #define SNDRV_RAWMIDI_MODE_CLOCK_REALTIME	(1<<3)
75008fdced6SDavid Henningsson #define SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC	(2<<3)
75108fdced6SDavid Henningsson #define SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC_RAW	(3<<3)
75208fdced6SDavid Henningsson 
75308fdced6SDavid Henningsson #define SNDRV_RAWMIDI_FRAMING_DATA_LENGTH 16
75408fdced6SDavid Henningsson 
75508fdced6SDavid Henningsson struct snd_rawmidi_framing_tstamp {
75608fdced6SDavid Henningsson 	/* For now, frame_type is always 0. Midi 2.0 is expected to add new
75708fdced6SDavid Henningsson 	 * types here. Applications are expected to skip unknown frame types.
75808fdced6SDavid Henningsson 	 */
75908fdced6SDavid Henningsson 	__u8 frame_type;
76008fdced6SDavid Henningsson 	__u8 length; /* number of valid bytes in data field */
76108fdced6SDavid Henningsson 	__u8 reserved[2];
76208fdced6SDavid Henningsson 	__u32 tv_nsec;		/* nanoseconds */
763674e95caSDavid Howells 	__u64 tv_sec;		/* seconds */
764674e95caSDavid Howells 	__u8 data[SNDRV_RAWMIDI_FRAMING_DATA_LENGTH];
765674e95caSDavid Howells } __packed;
766674e95caSDavid Howells 
767674e95caSDavid Howells struct snd_rawmidi_params {
76808fdced6SDavid Henningsson 	int stream;
76908fdced6SDavid Henningsson 	size_t buffer_size;		/* queue size in bytes */
770674e95caSDavid Howells 	size_t avail_min;		/* minimum avail bytes for wakeup */
771674e95caSDavid Howells 	unsigned int no_active_sensing: 1; /* do not send active sensing byte in close() */
772d9e5582cSBaolin Wang 	unsigned int mode;		/* For input data only, frame incoming data */
773674e95caSDavid Howells 	unsigned char reserved[12];	/* reserved for future use */
774674e95caSDavid Howells };
775d9e5582cSBaolin Wang 
776674e95caSDavid Howells #ifndef __KERNEL__
777674e95caSDavid Howells struct snd_rawmidi_status {
778674e95caSDavid Howells 	int stream;
779674e95caSDavid Howells 	__time_pad pad1;
780674e95caSDavid Howells 	struct timespec tstamp;		/* Timestamp */
781d9e5582cSBaolin Wang 	size_t avail;			/* available bytes */
782674e95caSDavid Howells 	size_t xruns;			/* count of overruns since last status (in bytes) */
783*01dfa8e9STakashi Iwai 	unsigned char reserved[16];	/* reserved for future use */
784*01dfa8e9STakashi Iwai };
785*01dfa8e9STakashi Iwai #endif
786e3a8a5b7STakashi Iwai 
787e3a8a5b7STakashi Iwai /* UMP EP info flags */
788e3a8a5b7STakashi Iwai #define SNDRV_UMP_EP_INFO_STATIC_BLOCKS		0x01
789e3a8a5b7STakashi Iwai 
790e3a8a5b7STakashi Iwai /* UMP EP Protocol / JRTS capability bits */
791e3a8a5b7STakashi Iwai #define SNDRV_UMP_EP_INFO_PROTO_MIDI_MASK	0x0300
792e3a8a5b7STakashi Iwai #define SNDRV_UMP_EP_INFO_PROTO_MIDI1		0x0100 /* MIDI 1.0 */
793e3a8a5b7STakashi Iwai #define SNDRV_UMP_EP_INFO_PROTO_MIDI2		0x0200 /* MIDI 2.0 */
794e3a8a5b7STakashi Iwai #define SNDRV_UMP_EP_INFO_PROTO_JRTS_MASK	0x0003
795e3a8a5b7STakashi Iwai #define SNDRV_UMP_EP_INFO_PROTO_JRTS_TX		0x0001 /* JRTS Transmit */
796e3a8a5b7STakashi Iwai #define SNDRV_UMP_EP_INFO_PROTO_JRTS_RX		0x0002 /* JRTS Receive */
797e3a8a5b7STakashi Iwai 
798e3a8a5b7STakashi Iwai /* UMP Endpoint information */
799e3a8a5b7STakashi Iwai struct snd_ump_endpoint_info {
800e3a8a5b7STakashi Iwai 	int card;			/* card number */
801e3a8a5b7STakashi Iwai 	int device;			/* device number */
802e3a8a5b7STakashi Iwai 	unsigned int flags;		/* additional info */
803e375b8a0STakashi Iwai 	unsigned int protocol_caps;	/* protocol capabilities */
804e375b8a0STakashi Iwai 	unsigned int protocol;		/* current protocol */
805e375b8a0STakashi Iwai 	unsigned int num_blocks;	/* # of function blocks */
806e375b8a0STakashi Iwai 	unsigned short version;		/* UMP major/minor version */
807e375b8a0STakashi Iwai 	unsigned short family_id;	/* MIDI device family ID */
808e3a8a5b7STakashi Iwai 	unsigned short model_id;	/* MIDI family model ID */
809e3a8a5b7STakashi Iwai 	unsigned int manufacturer_id;	/* MIDI manufacturer ID */
810e3a8a5b7STakashi Iwai 	unsigned char sw_revision[4];	/* software revision */
811e3a8a5b7STakashi Iwai 	unsigned short padding;
812e3a8a5b7STakashi Iwai 	unsigned char name[128];	/* endpoint name string */
813e3a8a5b7STakashi Iwai 	unsigned char product_id[128];	/* unique product id string */
814e3a8a5b7STakashi Iwai 	unsigned char reserved[32];
815e3a8a5b7STakashi Iwai } __packed;
816e3a8a5b7STakashi Iwai 
817e3a8a5b7STakashi Iwai /* UMP direction */
818e3a8a5b7STakashi Iwai #define SNDRV_UMP_DIR_INPUT		0x01
819e3a8a5b7STakashi Iwai #define SNDRV_UMP_DIR_OUTPUT		0x02
820e3a8a5b7STakashi Iwai #define SNDRV_UMP_DIR_BIDIRECTION	0x03
821e3a8a5b7STakashi Iwai 
822e375b8a0STakashi Iwai /* UMP block info flags */
823e375b8a0STakashi Iwai #define SNDRV_UMP_BLOCK_IS_MIDI1	(1U << 0) /* MIDI 1.0 port w/o restrict */
824e375b8a0STakashi Iwai #define SNDRV_UMP_BLOCK_IS_LOWSPEED	(1U << 1) /* 31.25Kbps B/W MIDI1 port */
825e375b8a0STakashi Iwai 
826e375b8a0STakashi Iwai /* UMP block user-interface hint */
827e375b8a0STakashi Iwai #define SNDRV_UMP_BLOCK_UI_HINT_UNKNOWN		0x00
828e3a8a5b7STakashi Iwai #define SNDRV_UMP_BLOCK_UI_HINT_RECEIVER	0x01
829e3a8a5b7STakashi Iwai #define SNDRV_UMP_BLOCK_UI_HINT_SENDER		0x02
830e3a8a5b7STakashi Iwai #define SNDRV_UMP_BLOCK_UI_HINT_BOTH		0x03
831e3a8a5b7STakashi Iwai 
832e3a8a5b7STakashi Iwai /* UMP groups and blocks */
833e3a8a5b7STakashi Iwai #define SNDRV_UMP_MAX_GROUPS		16
834e3a8a5b7STakashi Iwai #define SNDRV_UMP_MAX_BLOCKS		32
835e3a8a5b7STakashi Iwai 
836e3a8a5b7STakashi Iwai /* UMP Block information */
837e3a8a5b7STakashi Iwai struct snd_ump_block_info {
838e3a8a5b7STakashi Iwai 	int card;			/* card number */
839e3a8a5b7STakashi Iwai 	int device;			/* device number */
840e3a8a5b7STakashi Iwai 	unsigned char block_id;		/* block ID (R/W) */
841e375b8a0STakashi Iwai 	unsigned char direction;	/* UMP direction */
842e375b8a0STakashi Iwai 	unsigned char active;		/* Activeness */
843e375b8a0STakashi Iwai 	unsigned char first_group;	/* first group ID */
844e3a8a5b7STakashi Iwai 	unsigned char num_groups;	/* number of groups */
845e3a8a5b7STakashi Iwai 	unsigned char midi_ci_version;	/* MIDI-CI support version */
846e3a8a5b7STakashi Iwai 	unsigned char sysex8_streams;	/* max number of sysex8 streams */
847e3a8a5b7STakashi Iwai 	unsigned char ui_hint;		/* user interface hint */
848e3a8a5b7STakashi Iwai 	unsigned int flags;		/* various info flags */
849674e95caSDavid Howells 	unsigned char name[128];	/* block name string */
850674e95caSDavid Howells 	unsigned char reserved[32];
85109d23174SJaroslav Kysela } __packed;
852674e95caSDavid Howells 
853674e95caSDavid Howells #define SNDRV_RAWMIDI_IOCTL_PVERSION	_IOR('W', 0x00, int)
854674e95caSDavid Howells #define SNDRV_RAWMIDI_IOCTL_INFO	_IOR('W', 0x01, struct snd_rawmidi_info)
855674e95caSDavid Howells #define SNDRV_RAWMIDI_IOCTL_USER_PVERSION _IOW('W', 0x02, int)
856e3a8a5b7STakashi Iwai #define SNDRV_RAWMIDI_IOCTL_PARAMS	_IOWR('W', 0x10, struct snd_rawmidi_params)
857e3a8a5b7STakashi Iwai #define SNDRV_RAWMIDI_IOCTL_STATUS	_IOWR('W', 0x20, struct snd_rawmidi_status)
858e3a8a5b7STakashi Iwai #define SNDRV_RAWMIDI_IOCTL_DROP	_IOW('W', 0x30, int)
859674e95caSDavid Howells #define SNDRV_RAWMIDI_IOCTL_DRAIN	_IOW('W', 0x31, int)
860674e95caSDavid Howells /* Additional ioctls for UMP rawmidi devices */
861674e95caSDavid Howells #define SNDRV_UMP_IOCTL_ENDPOINT_INFO	_IOR('W', 0x40, struct snd_ump_endpoint_info)
862674e95caSDavid Howells #define SNDRV_UMP_IOCTL_BLOCK_INFO	_IOR('W', 0x41, struct snd_ump_block_info)
863674e95caSDavid Howells 
8641cfaef96SArnd Bergmann /*
865674e95caSDavid Howells  *  Timer section - /dev/snd/timer
866674e95caSDavid Howells  */
867674e95caSDavid Howells 
868674e95caSDavid Howells #define SNDRV_TIMER_VERSION		SNDRV_PROTOCOL_VERSION(2, 0, 7)
869674e95caSDavid Howells 
870674e95caSDavid Howells enum {
871674e95caSDavid Howells 	SNDRV_TIMER_CLASS_NONE = -1,
872674e95caSDavid Howells 	SNDRV_TIMER_CLASS_SLAVE = 0,
873674e95caSDavid Howells 	SNDRV_TIMER_CLASS_GLOBAL,
874674e95caSDavid Howells 	SNDRV_TIMER_CLASS_CARD,
875674e95caSDavid Howells 	SNDRV_TIMER_CLASS_PCM,
876674e95caSDavid Howells 	SNDRV_TIMER_CLASS_LAST = SNDRV_TIMER_CLASS_PCM,
877674e95caSDavid Howells };
878674e95caSDavid Howells 
879674e95caSDavid Howells /* slave timer classes */
880674e95caSDavid Howells enum {
881674e95caSDavid Howells 	SNDRV_TIMER_SCLASS_NONE = 0,
882674e95caSDavid Howells 	SNDRV_TIMER_SCLASS_APPLICATION,
883674e95caSDavid Howells 	SNDRV_TIMER_SCLASS_SEQUENCER,		/* alias */
884674e95caSDavid Howells 	SNDRV_TIMER_SCLASS_OSS_SEQUENCER,	/* alias */
885674e95caSDavid Howells 	SNDRV_TIMER_SCLASS_LAST = SNDRV_TIMER_SCLASS_OSS_SEQUENCER,
88634ce71a9SAlexandre Belloni };
887674e95caSDavid Howells 
888674e95caSDavid Howells /* global timers (device member) */
889674e95caSDavid Howells #define SNDRV_TIMER_GLOBAL_SYSTEM	0
890674e95caSDavid Howells #define SNDRV_TIMER_GLOBAL_RTC		1	/* unused */
891674e95caSDavid Howells #define SNDRV_TIMER_GLOBAL_HPET		2
892674e95caSDavid Howells #define SNDRV_TIMER_GLOBAL_HRTIMER	3
893674e95caSDavid Howells 
894674e95caSDavid Howells /* info flags */
895674e95caSDavid Howells #define SNDRV_TIMER_FLG_SLAVE		(1<<0)	/* cannot be controlled */
896674e95caSDavid Howells 
897674e95caSDavid Howells struct snd_timer_id {
898674e95caSDavid Howells 	int dev_class;
899674e95caSDavid Howells 	int dev_sclass;
900674e95caSDavid Howells 	int card;
901674e95caSDavid Howells 	int device;
902674e95caSDavid Howells 	int subdevice;
903674e95caSDavid Howells };
904674e95caSDavid Howells 
905674e95caSDavid Howells struct snd_timer_ginfo {
906674e95caSDavid Howells 	struct snd_timer_id tid;	/* requested timer ID */
907674e95caSDavid Howells 	unsigned int flags;		/* timer flags - SNDRV_TIMER_FLG_* */
908674e95caSDavid Howells 	int card;			/* card number */
909674e95caSDavid Howells 	unsigned char id[64];		/* timer identification */
910674e95caSDavid Howells 	unsigned char name[80];		/* timer name */
911674e95caSDavid Howells 	unsigned long reserved0;	/* reserved for future use */
912674e95caSDavid Howells 	unsigned long resolution;	/* average period resolution in ns */
913674e95caSDavid Howells 	unsigned long resolution_min;	/* minimal period resolution in ns */
914674e95caSDavid Howells 	unsigned long resolution_max;	/* maximal period resolution in ns */
915674e95caSDavid Howells 	unsigned int clients;		/* active timer clients */
916674e95caSDavid Howells 	unsigned char reserved[32];
917674e95caSDavid Howells };
918674e95caSDavid Howells 
919674e95caSDavid Howells struct snd_timer_gparams {
920674e95caSDavid Howells 	struct snd_timer_id tid;	/* requested timer ID */
921674e95caSDavid Howells 	unsigned long period_num;	/* requested precise period duration (in seconds) - numerator */
922674e95caSDavid Howells 	unsigned long period_den;	/* requested precise period duration (in seconds) - denominator */
923674e95caSDavid Howells 	unsigned char reserved[32];
924674e95caSDavid Howells };
925674e95caSDavid Howells 
926674e95caSDavid Howells struct snd_timer_gstatus {
927674e95caSDavid Howells 	struct snd_timer_id tid;	/* requested timer ID */
928674e95caSDavid Howells 	unsigned long resolution;	/* current period resolution in ns */
929674e95caSDavid Howells 	unsigned long resolution_num;	/* precise current period resolution (in seconds) - numerator */
930674e95caSDavid Howells 	unsigned long resolution_den;	/* precise current period resolution (in seconds) - denominator */
931674e95caSDavid Howells 	unsigned char reserved[32];
932674e95caSDavid Howells };
933674e95caSDavid Howells 
934674e95caSDavid Howells struct snd_timer_select {
935674e95caSDavid Howells 	struct snd_timer_id id;	/* bind to timer ID */
936674e95caSDavid Howells 	unsigned char reserved[32];	/* reserved */
937674e95caSDavid Howells };
938674e95caSDavid Howells 
939674e95caSDavid Howells struct snd_timer_info {
940674e95caSDavid Howells 	unsigned int flags;		/* timer flags - SNDRV_TIMER_FLG_* */
941674e95caSDavid Howells 	int card;			/* card number */
942674e95caSDavid Howells 	unsigned char id[64];		/* timer identificator */
943674e95caSDavid Howells 	unsigned char name[80];		/* timer name */
944674e95caSDavid Howells 	unsigned long reserved0;	/* reserved for future use */
945674e95caSDavid Howells 	unsigned long resolution;	/* average period resolution in ns */
946674e95caSDavid Howells 	unsigned char reserved[64];	/* reserved */
947674e95caSDavid Howells };
948674e95caSDavid Howells 
949674e95caSDavid Howells #define SNDRV_TIMER_PSFLG_AUTO		(1<<0)	/* auto start, otherwise one-shot */
950a9840151STakashi Sakamoto #define SNDRV_TIMER_PSFLG_EXCLUSIVE	(1<<1)	/* exclusive use, precise start/stop/pause/continue */
951674e95caSDavid Howells #define SNDRV_TIMER_PSFLG_EARLY_EVENT	(1<<2)	/* write early event to the poll queue */
952674e95caSDavid Howells 
953674e95caSDavid Howells struct snd_timer_params {
954674e95caSDavid Howells 	unsigned int flags;		/* flags - SNDRV_TIMER_PSFLG_* */
955674e95caSDavid Howells 	unsigned int ticks;		/* requested resolution in ticks */
956674e95caSDavid Howells 	unsigned int queue_size;	/* total size of queue (32-1024) */
957674e95caSDavid Howells 	unsigned int reserved0;		/* reserved, was: failure locations */
958a07804ccSBaolin Wang 	unsigned int filter;		/* event filter (bitmask of SNDRV_TIMER_EVENT_*) */
959674e95caSDavid Howells 	unsigned char reserved[60];	/* reserved */
960674e95caSDavid Howells };
961674e95caSDavid Howells 
962674e95caSDavid Howells #ifndef __KERNEL__
963674e95caSDavid Howells struct snd_timer_status {
964674e95caSDavid Howells 	struct timespec tstamp;		/* Timestamp - last update */
965674e95caSDavid Howells 	unsigned int resolution;	/* current period resolution in ns */
966674e95caSDavid Howells 	unsigned int lost;		/* counter of master tick lost */
967a07804ccSBaolin Wang 	unsigned int overrun;		/* count of read queue overruns */
968674e95caSDavid Howells 	unsigned int queue;		/* used queue size */
969674e95caSDavid Howells 	unsigned char reserved[64];	/* reserved */
970674e95caSDavid Howells };
97107094ae6SBaolin Wang #endif
972674e95caSDavid Howells 
973674e95caSDavid Howells #define SNDRV_TIMER_IOCTL_PVERSION	_IOR('T', 0x00, int)
974674e95caSDavid Howells #define SNDRV_TIMER_IOCTL_NEXT_DEVICE	_IOWR('T', 0x01, struct snd_timer_id)
975674e95caSDavid Howells #define SNDRV_TIMER_IOCTL_TREAD_OLD	_IOW('T', 0x02, int)
976674e95caSDavid Howells #define SNDRV_TIMER_IOCTL_GINFO		_IOWR('T', 0x03, struct snd_timer_ginfo)
977674e95caSDavid Howells #define SNDRV_TIMER_IOCTL_GPARAMS	_IOW('T', 0x04, struct snd_timer_gparams)
978674e95caSDavid Howells #define SNDRV_TIMER_IOCTL_GSTATUS	_IOWR('T', 0x05, struct snd_timer_gstatus)
979674e95caSDavid Howells #define SNDRV_TIMER_IOCTL_SELECT	_IOW('T', 0x10, struct snd_timer_select)
980674e95caSDavid Howells #define SNDRV_TIMER_IOCTL_INFO		_IOR('T', 0x11, struct snd_timer_info)
981674e95caSDavid Howells #define SNDRV_TIMER_IOCTL_PARAMS	_IOW('T', 0x12, struct snd_timer_params)
982674e95caSDavid Howells #define SNDRV_TIMER_IOCTL_STATUS	_IOR('T', 0x14, struct snd_timer_status)
983674e95caSDavid Howells /* The following four ioctls are changed since 1.0.9 due to confliction */
98407094ae6SBaolin Wang #define SNDRV_TIMER_IOCTL_START		_IO('T', 0xa0)
98507094ae6SBaolin Wang #define SNDRV_TIMER_IOCTL_STOP		_IO('T', 0xa1)
98607094ae6SBaolin Wang #define SNDRV_TIMER_IOCTL_CONTINUE	_IO('T', 0xa2)
98707094ae6SBaolin Wang #define SNDRV_TIMER_IOCTL_PAUSE		_IO('T', 0xa3)
98807094ae6SBaolin Wang #define SNDRV_TIMER_IOCTL_TREAD64	_IOW('T', 0xa4, int)
98907094ae6SBaolin Wang 
99007094ae6SBaolin Wang #if __BITS_PER_LONG == 64
99107094ae6SBaolin Wang #define SNDRV_TIMER_IOCTL_TREAD SNDRV_TIMER_IOCTL_TREAD_OLD
99207094ae6SBaolin Wang #else
993674e95caSDavid Howells #define SNDRV_TIMER_IOCTL_TREAD ((sizeof(__kernel_long_t) >= sizeof(time_t)) ? \
994674e95caSDavid Howells 				 SNDRV_TIMER_IOCTL_TREAD_OLD : \
995674e95caSDavid Howells 				 SNDRV_TIMER_IOCTL_TREAD64)
996674e95caSDavid Howells #endif
997674e95caSDavid Howells 
998674e95caSDavid Howells struct snd_timer_read {
999674e95caSDavid Howells 	unsigned int resolution;
1000674e95caSDavid Howells 	unsigned int ticks;
1001674e95caSDavid Howells };
1002674e95caSDavid Howells 
1003674e95caSDavid Howells enum {
1004674e95caSDavid Howells 	SNDRV_TIMER_EVENT_RESOLUTION = 0,	/* val = resolution in ns */
1005674e95caSDavid Howells 	SNDRV_TIMER_EVENT_TICK,			/* val = ticks */
1006674e95caSDavid Howells 	SNDRV_TIMER_EVENT_START,		/* val = resolution in ns */
1007674e95caSDavid Howells 	SNDRV_TIMER_EVENT_STOP,			/* val = 0 */
1008674e95caSDavid Howells 	SNDRV_TIMER_EVENT_CONTINUE,		/* val = resolution in ns */
1009674e95caSDavid Howells 	SNDRV_TIMER_EVENT_PAUSE,		/* val = 0 */
1010674e95caSDavid Howells 	SNDRV_TIMER_EVENT_EARLY,		/* val = 0, early event */
1011674e95caSDavid Howells 	SNDRV_TIMER_EVENT_SUSPEND,		/* val = 0 */
1012674e95caSDavid Howells 	SNDRV_TIMER_EVENT_RESUME,		/* val = resolution in ns */
1013674e95caSDavid Howells 	/* master timer events for slave timer instances */
1014674e95caSDavid Howells 	SNDRV_TIMER_EVENT_MSTART = SNDRV_TIMER_EVENT_START + 10,
1015674e95caSDavid Howells 	SNDRV_TIMER_EVENT_MSTOP = SNDRV_TIMER_EVENT_STOP + 10,
1016674e95caSDavid Howells 	SNDRV_TIMER_EVENT_MCONTINUE = SNDRV_TIMER_EVENT_CONTINUE + 10,
1017674e95caSDavid Howells 	SNDRV_TIMER_EVENT_MPAUSE = SNDRV_TIMER_EVENT_PAUSE + 10,
101807094ae6SBaolin Wang 	SNDRV_TIMER_EVENT_MSUSPEND = SNDRV_TIMER_EVENT_SUSPEND + 10,
1019674e95caSDavid Howells 	SNDRV_TIMER_EVENT_MRESUME = SNDRV_TIMER_EVENT_RESUME + 10,
1020674e95caSDavid Howells };
102107094ae6SBaolin Wang 
1022674e95caSDavid Howells #ifndef __KERNEL__
1023674e95caSDavid Howells struct snd_timer_tread {
102407094ae6SBaolin Wang 	int event;
1025674e95caSDavid Howells 	__time_pad pad1;
102607094ae6SBaolin Wang 	struct timespec tstamp;
1027674e95caSDavid Howells 	unsigned int val;
1028674e95caSDavid Howells 	__time_pad pad2;
1029674e95caSDavid Howells };
1030674e95caSDavid Howells #endif
1031674e95caSDavid Howells 
1032674e95caSDavid Howells /****************************************************************************
1033674e95caSDavid Howells  *                                                                          *
1034127ae6f6STakashi Iwai  *        Section for driver control interface - /dev/snd/control?          *
1035674e95caSDavid Howells  *                                                                          *
1036674e95caSDavid Howells  ****************************************************************************/
1037674e95caSDavid Howells 
1038674e95caSDavid Howells #define SNDRV_CTL_VERSION		SNDRV_PROTOCOL_VERSION(2, 0, 9)
1039674e95caSDavid Howells 
1040674e95caSDavid Howells struct snd_ctl_card_info {
1041674e95caSDavid Howells 	int card;			/* card number */
1042674e95caSDavid Howells 	int pad;			/* reserved for future (was type) */
1043674e95caSDavid Howells 	unsigned char id[16];		/* ID of card (user selectable) */
1044674e95caSDavid Howells 	unsigned char driver[16];	/* Driver name */
1045674e95caSDavid Howells 	unsigned char name[32];		/* Short name of soundcard */
1046674e95caSDavid Howells 	unsigned char longname[80];	/* name + info text about soundcard */
1047674e95caSDavid Howells 	unsigned char reserved_[16];	/* reserved for future (was ID of mixer) */
1048674e95caSDavid Howells 	unsigned char mixername[80];	/* visual mixer identification */
1049674e95caSDavid Howells 	unsigned char components[128];	/* card components / fine identification, delimited with one space (AC97 etc..) */
1050674e95caSDavid Howells };
1051674e95caSDavid Howells 
1052674e95caSDavid Howells typedef int __bitwise snd_ctl_elem_type_t;
1053674e95caSDavid Howells #define	SNDRV_CTL_ELEM_TYPE_NONE	((__force snd_ctl_elem_type_t) 0) /* invalid */
1054674e95caSDavid Howells #define	SNDRV_CTL_ELEM_TYPE_BOOLEAN	((__force snd_ctl_elem_type_t) 1) /* boolean type */
1055674e95caSDavid Howells #define	SNDRV_CTL_ELEM_TYPE_INTEGER	((__force snd_ctl_elem_type_t) 2) /* integer type */
1056674e95caSDavid Howells #define	SNDRV_CTL_ELEM_TYPE_ENUMERATED	((__force snd_ctl_elem_type_t) 3) /* enumerated type */
1057674e95caSDavid Howells #define	SNDRV_CTL_ELEM_TYPE_BYTES	((__force snd_ctl_elem_type_t) 4) /* byte array */
1058674e95caSDavid Howells #define	SNDRV_CTL_ELEM_TYPE_IEC958	((__force snd_ctl_elem_type_t) 5) /* IEC958 (S/PDIF) setup */
1059674e95caSDavid Howells #define	SNDRV_CTL_ELEM_TYPE_INTEGER64	((__force snd_ctl_elem_type_t) 6) /* 64-bit integer type */
1060674e95caSDavid Howells #define	SNDRV_CTL_ELEM_TYPE_LAST	SNDRV_CTL_ELEM_TYPE_INTEGER64
1061674e95caSDavid Howells 
1062674e95caSDavid Howells typedef int __bitwise snd_ctl_elem_iface_t;
1063674e95caSDavid Howells #define	SNDRV_CTL_ELEM_IFACE_CARD	((__force snd_ctl_elem_iface_t) 0) /* global control */
1064674e95caSDavid Howells #define	SNDRV_CTL_ELEM_IFACE_HWDEP	((__force snd_ctl_elem_iface_t) 1) /* hardware dependent device */
1065674e95caSDavid Howells #define	SNDRV_CTL_ELEM_IFACE_MIXER	((__force snd_ctl_elem_iface_t) 2) /* virtual mixer device */
1066674e95caSDavid Howells #define	SNDRV_CTL_ELEM_IFACE_PCM	((__force snd_ctl_elem_iface_t) 3) /* PCM device */
1067674e95caSDavid Howells #define	SNDRV_CTL_ELEM_IFACE_RAWMIDI	((__force snd_ctl_elem_iface_t) 4) /* RawMidi device */
1068674e95caSDavid Howells #define	SNDRV_CTL_ELEM_IFACE_TIMER	((__force snd_ctl_elem_iface_t) 5) /* timer device */
1069674e95caSDavid Howells #define	SNDRV_CTL_ELEM_IFACE_SEQUENCER	((__force snd_ctl_elem_iface_t) 6) /* sequencer client */
1070674e95caSDavid Howells #define	SNDRV_CTL_ELEM_IFACE_LAST	SNDRV_CTL_ELEM_IFACE_SEQUENCER
1071674e95caSDavid Howells 
10725aec579eSTakashi Iwai #define SNDRV_CTL_ELEM_ACCESS_READ		(1<<0)
1073674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_WRITE		(1<<1)
1074674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_READWRITE		(SNDRV_CTL_ELEM_ACCESS_READ|SNDRV_CTL_ELEM_ACCESS_WRITE)
1075674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_VOLATILE		(1<<2)	/* control value may be changed without a notification */
1076674e95caSDavid Howells /* (1 << 3) is unused. */
1077674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_TLV_READ		(1<<4)	/* TLV read is possible */
1078674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_TLV_WRITE		(1<<5)	/* TLV write is possible */
1079674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE	(SNDRV_CTL_ELEM_ACCESS_TLV_READ|SNDRV_CTL_ELEM_ACCESS_TLV_WRITE)
1080674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_TLV_COMMAND	(1<<6)	/* TLV command is possible */
1081674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_INACTIVE		(1<<8)	/* control does actually nothing, but may be updated */
1082674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_LOCK		(1<<9)	/* write lock */
1083674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_OWNER		(1<<10)	/* write lock owner */
1084674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK	(1<<28)	/* kernel use a TLV callback */
1085674e95caSDavid Howells #define SNDRV_CTL_ELEM_ACCESS_USER		(1<<29) /* user space element */
1086674e95caSDavid Howells /* bits 30 and 31 are obsoleted (for indirect access) */
1087674e95caSDavid Howells 
1088674e95caSDavid Howells /* for further details see the ACPI and PCI power management specification */
1089674e95caSDavid Howells #define SNDRV_CTL_POWER_D0		0x0000	/* full On */
1090674e95caSDavid Howells #define SNDRV_CTL_POWER_D1		0x0100	/* partial On */
1091674e95caSDavid Howells #define SNDRV_CTL_POWER_D2		0x0200	/* partial On */
1092975cc02aSTakashi Iwai #define SNDRV_CTL_POWER_D3		0x0300	/* Off */
1093975cc02aSTakashi Iwai #define SNDRV_CTL_POWER_D3hot		(SNDRV_CTL_POWER_D3|0x0000)	/* Off, with power */
1094674e95caSDavid Howells #define SNDRV_CTL_POWER_D3cold		(SNDRV_CTL_POWER_D3|0x0001)	/* Off, without power */
1095674e95caSDavid Howells 
1096674e95caSDavid Howells #define SNDRV_CTL_ELEM_ID_NAME_MAXLEN	44
1097674e95caSDavid Howells 
1098674e95caSDavid Howells struct snd_ctl_elem_id {
109943c499dcSVinod Koul 	unsigned int numid;		/* numeric identifier, zero = invalid */
1100674e95caSDavid Howells 	snd_ctl_elem_iface_t iface;	/* interface identifier */
1101674e95caSDavid Howells 	unsigned int device;		/* device/client number */
1102674e95caSDavid Howells 	unsigned int subdevice;		/* subdevice (substream) number */
1103674e95caSDavid Howells 	unsigned char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];		/* ASCII name of item */
1104674e95caSDavid Howells 	unsigned int index;		/* index of item */
1105674e95caSDavid Howells };
1106674e95caSDavid Howells 
1107674e95caSDavid Howells struct snd_ctl_elem_list {
1108674e95caSDavid Howells 	unsigned int offset;		/* W: first element ID to get */
1109674e95caSDavid Howells 	unsigned int space;		/* W: count of element IDs to get */
1110674e95caSDavid Howells 	unsigned int used;		/* R: count of element IDs set */
1111674e95caSDavid Howells 	unsigned int count;		/* R: count of all elements */
1112674e95caSDavid Howells 	struct snd_ctl_elem_id __user *pids; /* R: IDs */
1113674e95caSDavid Howells 	unsigned char reserved[50];
1114674e95caSDavid Howells };
1115674e95caSDavid Howells 
1116674e95caSDavid Howells struct snd_ctl_elem_info {
1117674e95caSDavid Howells 	struct snd_ctl_elem_id id;	/* W: element ID */
1118674e95caSDavid Howells 	snd_ctl_elem_type_t type;	/* R: value type - SNDRV_CTL_ELEM_TYPE_* */
1119674e95caSDavid Howells 	unsigned int access;		/* R: value access (bitmask) - SNDRV_CTL_ELEM_ACCESS_* */
1120674e95caSDavid Howells 	unsigned int count;		/* count of values */
1121674e95caSDavid Howells 	__kernel_pid_t owner;		/* owner's PID of this control */
1122674e95caSDavid Howells 	union {
1123674e95caSDavid Howells 		struct {
1124674e95caSDavid Howells 			long min;		/* R: minimum value */
1125674e95caSDavid Howells 			long max;		/* R: maximum value */
1126674e95caSDavid Howells 			long step;		/* R: step (0 variable) */
1127674e95caSDavid Howells 		} integer;
1128674e95caSDavid Howells 		struct {
1129674e95caSDavid Howells 			long long min;		/* R: minimum value */
1130674e95caSDavid Howells 			long long max;		/* R: maximum value */
1131674e95caSDavid Howells 			long long step;		/* R: step (0 variable) */
1132674e95caSDavid Howells 		} integer64;
1133674e95caSDavid Howells 		struct {
1134674e95caSDavid Howells 			unsigned int items;	/* R: number of items */
1135674e95caSDavid Howells 			unsigned int item;	/* W: item number */
1136674e95caSDavid Howells 			char name[64];		/* R: value name */
1137674e95caSDavid Howells 			__u64 names_ptr;	/* W: names list (ELEM_ADD only) */
1138ff16351eSTakashi Sakamoto 			unsigned int names_length;
1139674e95caSDavid Howells 		} enumerated;
1140674e95caSDavid Howells 		unsigned char reserved[128];
1141674e95caSDavid Howells 	} value;
1142674e95caSDavid Howells 	unsigned char reserved[64];
1143674e95caSDavid Howells };
1144674e95caSDavid Howells 
1145674e95caSDavid Howells struct snd_ctl_elem_value {
1146674e95caSDavid Howells 	struct snd_ctl_elem_id id;	/* W: element ID */
1147674e95caSDavid Howells 	unsigned int indirect: 1;	/* W: indirect access - obsoleted */
1148674e95caSDavid Howells 	union {
1149674e95caSDavid Howells 		union {
1150674e95caSDavid Howells 			long value[128];
1151674e95caSDavid Howells 			long *value_ptr;	/* obsoleted */
1152674e95caSDavid Howells 		} integer;
1153674e95caSDavid Howells 		union {
1154674e95caSDavid Howells 			long long value[64];
1155674e95caSDavid Howells 			long long *value_ptr;	/* obsoleted */
1156674e95caSDavid Howells 		} integer64;
1157674e95caSDavid Howells 		union {
1158674e95caSDavid Howells 			unsigned int item[128];
1159674e95caSDavid Howells 			unsigned int *item_ptr;	/* obsoleted */
1160674e95caSDavid Howells 		} enumerated;
1161674e95caSDavid Howells 		union {
1162674e95caSDavid Howells 			unsigned char data[512];
1163a4e7dd35SBaolin Wang 			unsigned char *data_ptr;	/* obsoleted */
1164674e95caSDavid Howells 		} bytes;
1165674e95caSDavid Howells 		struct snd_aes_iec958 iec958;
1166674e95caSDavid Howells 	} value;		/* RO */
1167674e95caSDavid Howells 	unsigned char reserved[128];
1168674e95caSDavid Howells };
116994dfc73eSGustavo A. R. Silva 
1170674e95caSDavid Howells struct snd_ctl_tlv {
1171674e95caSDavid Howells 	unsigned int numid;	/* control element numeric identification */
1172674e95caSDavid Howells 	unsigned int length;	/* in bytes aligned to 4 */
1173674e95caSDavid Howells 	unsigned int tlv[];	/* first TLV */
1174674e95caSDavid Howells };
1175674e95caSDavid Howells 
1176674e95caSDavid Howells #define SNDRV_CTL_IOCTL_PVERSION	_IOR('U', 0x00, int)
1177674e95caSDavid Howells #define SNDRV_CTL_IOCTL_CARD_INFO	_IOR('U', 0x01, struct snd_ctl_card_info)
1178674e95caSDavid Howells #define SNDRV_CTL_IOCTL_ELEM_LIST	_IOWR('U', 0x10, struct snd_ctl_elem_list)
1179674e95caSDavid Howells #define SNDRV_CTL_IOCTL_ELEM_INFO	_IOWR('U', 0x11, struct snd_ctl_elem_info)
1180674e95caSDavid Howells #define SNDRV_CTL_IOCTL_ELEM_READ	_IOWR('U', 0x12, struct snd_ctl_elem_value)
1181674e95caSDavid Howells #define SNDRV_CTL_IOCTL_ELEM_WRITE	_IOWR('U', 0x13, struct snd_ctl_elem_value)
1182674e95caSDavid Howells #define SNDRV_CTL_IOCTL_ELEM_LOCK	_IOW('U', 0x14, struct snd_ctl_elem_id)
1183674e95caSDavid Howells #define SNDRV_CTL_IOCTL_ELEM_UNLOCK	_IOW('U', 0x15, struct snd_ctl_elem_id)
1184674e95caSDavid Howells #define SNDRV_CTL_IOCTL_SUBSCRIBE_EVENTS _IOWR('U', 0x16, int)
1185674e95caSDavid Howells #define SNDRV_CTL_IOCTL_ELEM_ADD	_IOWR('U', 0x17, struct snd_ctl_elem_info)
1186674e95caSDavid Howells #define SNDRV_CTL_IOCTL_ELEM_REPLACE	_IOWR('U', 0x18, struct snd_ctl_elem_info)
1187674e95caSDavid Howells #define SNDRV_CTL_IOCTL_ELEM_REMOVE	_IOWR('U', 0x19, struct snd_ctl_elem_id)
1188674e95caSDavid Howells #define SNDRV_CTL_IOCTL_TLV_READ	_IOWR('U', 0x1a, struct snd_ctl_tlv)
1189674e95caSDavid Howells #define SNDRV_CTL_IOCTL_TLV_WRITE	_IOWR('U', 0x1b, struct snd_ctl_tlv)
1190674e95caSDavid Howells #define SNDRV_CTL_IOCTL_TLV_COMMAND	_IOWR('U', 0x1c, struct snd_ctl_tlv)
1191674e95caSDavid Howells #define SNDRV_CTL_IOCTL_HWDEP_NEXT_DEVICE _IOWR('U', 0x20, int)
1192674e95caSDavid Howells #define SNDRV_CTL_IOCTL_HWDEP_INFO	_IOR('U', 0x21, struct snd_hwdep_info)
1193674e95caSDavid Howells #define SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE	_IOR('U', 0x30, int)
1194674e95caSDavid Howells #define SNDRV_CTL_IOCTL_PCM_INFO	_IOWR('U', 0x31, struct snd_pcm_info)
1195127ae6f6STakashi Iwai #define SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE _IOW('U', 0x32, int)
119630fc1392STakashi Iwai #define SNDRV_CTL_IOCTL_RAWMIDI_NEXT_DEVICE _IOWR('U', 0x40, int)
119730fc1392STakashi Iwai #define SNDRV_CTL_IOCTL_RAWMIDI_INFO	_IOWR('U', 0x41, struct snd_rawmidi_info)
1198674e95caSDavid Howells #define SNDRV_CTL_IOCTL_RAWMIDI_PREFER_SUBDEVICE _IOW('U', 0x42, int)
1199674e95caSDavid Howells #define SNDRV_CTL_IOCTL_UMP_NEXT_DEVICE	_IOWR('U', 0x43, int)
1200674e95caSDavid Howells #define SNDRV_CTL_IOCTL_UMP_ENDPOINT_INFO _IOWR('U', 0x44, struct snd_ump_endpoint_info)
1201674e95caSDavid Howells #define SNDRV_CTL_IOCTL_UMP_BLOCK_INFO	_IOWR('U', 0x45, struct snd_ump_block_info)
1202674e95caSDavid Howells #define SNDRV_CTL_IOCTL_POWER		_IOWR('U', 0xd0, int)
1203674e95caSDavid Howells #define SNDRV_CTL_IOCTL_POWER_STATE	_IOR('U', 0xd1, int)
1204674e95caSDavid Howells 
1205674e95caSDavid Howells /*
1206674e95caSDavid Howells  *  Read interface.
1207674e95caSDavid Howells  */
1208674e95caSDavid Howells 
1209674e95caSDavid Howells enum sndrv_ctl_event_type {
1210674e95caSDavid Howells 	SNDRV_CTL_EVENT_ELEM = 0,
1211674e95caSDavid Howells 	SNDRV_CTL_EVENT_LAST = SNDRV_CTL_EVENT_ELEM,
1212674e95caSDavid Howells };
1213674e95caSDavid Howells 
1214674e95caSDavid Howells #define SNDRV_CTL_EVENT_MASK_VALUE	(1<<0)	/* element value was changed */
1215674e95caSDavid Howells #define SNDRV_CTL_EVENT_MASK_INFO	(1<<1)	/* element info was changed */
1216674e95caSDavid Howells #define SNDRV_CTL_EVENT_MASK_ADD	(1<<2)	/* element was added */
1217674e95caSDavid Howells #define SNDRV_CTL_EVENT_MASK_TLV	(1<<3)	/* element TLV tree was changed */
1218674e95caSDavid Howells #define SNDRV_CTL_EVENT_MASK_REMOVE	(~0U)	/* element was removed */
1219674e95caSDavid Howells 
1220674e95caSDavid Howells struct snd_ctl_event {
1221674e95caSDavid Howells 	int type;	/* event type - SNDRV_CTL_EVENT_* */
1222674e95caSDavid Howells 	union {
1223674e95caSDavid Howells 		struct {
1224674e95caSDavid Howells 			unsigned int mask;
1225674e95caSDavid Howells 			struct snd_ctl_elem_id id;
1226674e95caSDavid Howells 		} elem;
1227674e95caSDavid Howells 		unsigned char data8[60];
1228674e95caSDavid Howells 	} data;
1229674e95caSDavid Howells };
1230674e95caSDavid Howells 
1231674e95caSDavid Howells /*
1232674e95caSDavid Howells  *  Control names
1233674e95caSDavid Howells  */
1234674e95caSDavid Howells 
1235674e95caSDavid Howells #define SNDRV_CTL_NAME_NONE				""
1236674e95caSDavid Howells #define SNDRV_CTL_NAME_PLAYBACK				"Playback "
1237674e95caSDavid Howells #define SNDRV_CTL_NAME_CAPTURE				"Capture "
1238674e95caSDavid Howells 
1239674e95caSDavid Howells #define SNDRV_CTL_NAME_IEC958_NONE			""
1240674e95caSDavid Howells #define SNDRV_CTL_NAME_IEC958_SWITCH			"Switch"
1241674e95caSDavid Howells #define SNDRV_CTL_NAME_IEC958_VOLUME			"Volume"
1242674e95caSDavid Howells #define SNDRV_CTL_NAME_IEC958_DEFAULT			"Default"
1243674e95caSDavid Howells #define SNDRV_CTL_NAME_IEC958_MASK			"Mask"
1244674e95caSDavid Howells #define SNDRV_CTL_NAME_IEC958_CON_MASK			"Con Mask"
1245674e95caSDavid Howells #define SNDRV_CTL_NAME_IEC958_PRO_MASK			"Pro Mask"
1246 #define SNDRV_CTL_NAME_IEC958_PCM_STREAM		"PCM Stream"
1247 #define SNDRV_CTL_NAME_IEC958(expl,direction,what)	"IEC958 " expl SNDRV_CTL_NAME_##direction SNDRV_CTL_NAME_IEC958_##what
1248 
1249 #endif /* _UAPI__SOUND_ASOUND_H */
1250