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