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