include/uapi/sound/asound.h

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